Represents a collection on DomainNameAccessAssociations resources.
Parameters:
-
position
(Optional[String], default:
None
)
–
The current pagination position in the paged result set.
-
limit
(Optional[NullableInteger], default:
None
)
–
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
-
resource_owner
(Optional[ResourceOwner], default:
None
)
–
The owner of the domain name access association. Use SELF to only list the domain name access associations owned by your own account. Use OTHER_ACCOUNTS to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.
Raises:
-
BadRequestException
–
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
NotFoundException
–
The requested resource is not found. Make sure that the request URI is correct.
-
TooManyRequestsException
–
The request has reached its throttling limit. Retry after the specified time period.
-
UnauthorizedException
–
The request is denied because the caller has insufficient permissions.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_api_gateway/_services/api_gateway.py
| def get_domain_name_access_associations(
self,
*,
config_overrides: Optional[APIGatewayClientConfig] = None,
position: Optional["capo_api_gateway.types.string.String"] = None,
limit: Optional[
"capo_api_gateway.types.nullable_integer.NullableInteger"
] = None,
resource_owner: Optional[
"capo_api_gateway.types.resource_owner.ResourceOwner"
] = None,
) -> "capo_api_gateway.types.domain_name_access_associations.DomainNameAccessAssociations":
"""<p>Represents a collection on DomainNameAccessAssociations resources.</p>
Args:
position: <p>The current pagination position in the paged result set. </p>
limit: <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500. </p>
resource_owner: <p> The owner of the domain name access association. Use <code>SELF</code> to only list the domain name access associations owned by your own account. Use <code>OTHER_ACCOUNTS</code> to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.</p>
Raises:
capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_api_gateway.types.get_domain_name_access_associations_request.GetDomainNameAccessAssociationsRequest]",
) -> OperationResponse[
"capo_api_gateway.types.domain_name_access_associations.DomainNameAccessAssociations"
]:
import capo_api_gateway._operations.backplane_control_service.get_domain_name_access_associations
output, http_response = (
capo_api_gateway._operations.backplane_control_service.get_domain_name_access_associations.get_domain_name_access_associations(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetDomainNameAccessAssociations")
)
input_: capo_api_gateway.types.get_domain_name_access_associations_request.GetDomainNameAccessAssociationsRequest = {}
if position is not None:
input_["position"] = position
if limit is not None:
input_["limit"] = limit
if resource_owner is not None:
input_["resource_owner"] = resource_owner
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|