Represents a collection of DomainName resources¶

Description¶

Represents a collection of DomainName resources.

Usage¶

apigateway_get_domain_names(position, limit, resourceOwner)

Arguments¶

position

The current pagination position in the paged result set.
limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
resourceOwner

The owner of the domain name access association.

Value¶

A list with the following syntax:

list(
  position = "string",
  items = list(
    list(
      domainName = "string",
      domainNameId = "string",
      domainNameArn = "string",
      certificateName = "string",
      certificateArn = "string",
      certificateUploadDate = as.POSIXct(
        "2015-01-01"
      ),
      regionalDomainName = "string",
      regionalHostedZoneId = "string",
      regionalCertificateName = "string",
      regionalCertificateArn = "string",
      distributionDomainName = "string",
      distributionHostedZoneId = "string",
      endpointConfiguration = list(
        types = list(
          "REGIONAL"|"EDGE"|"PRIVATE"
        ),
        ipAddressType = "ipv4"|"dualstack",
        vpcEndpointIds = list(
          "string"
        )
      ),
      domainNameStatus = "AVAILABLE"|"UPDATING"|"PENDING"|"PENDING_CERTIFICATE_REIMPORT"|"PENDING_OWNERSHIP_VERIFICATION"|"FAILED",
      domainNameStatusMessage = "string",
      securityPolicy = "TLS_1_0"|"TLS_1_2"|"SecurityPolicy_TLS13_1_3_2025_09"|"SecurityPolicy_TLS13_1_3_FIPS_2025_09"|"SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_FIPS_PFS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_Ext2_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_Ext2_FIPS_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_PQ_2025_09"|"SecurityPolicy_TLS13_1_2_2021_06"|"SecurityPolicy_TLS13_2025_EDGE"|"SecurityPolicy_TLS12_PFS_2025_EDGE"|"SecurityPolicy_TLS12_2018_EDGE",
      endpointAccessMode = "BASIC"|"STRICT",
      tags = list(
        "string"
      ),
      mutualTlsAuthentication = list(
        truststoreUri = "string",
        truststoreVersion = "string",
        truststoreWarnings = list(
          "string"
        )
      ),
      ownershipVerificationCertificateArn = "string",
      managementPolicy = "string",
      policy = "string",
      routingMode = "BASE_PATH_MAPPING_ONLY"|"ROUTING_RULE_ONLY"|"ROUTING_RULE_THEN_BASE_PATH_MAPPING"
    )
  )
)

Request syntax¶

svc$get_domain_names(
  position = "string",
  limit = 123,
  resourceOwner = "SELF"|"OTHER_ACCOUNTS"
)