Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.
Parameters:
-
directory_arn
(Arn)
–
The ARN of the directory you are listing.
-
schema_arn
(Optional[Arn], default:
None
)
–
The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.
-
next_token
(Optional[NextToken], default:
None
)
–
-
max_results
(Optional[NumberResults], default:
None
)
–
The maximum number of results to retrieve.
Raises:
-
AccessDeniedException
–
Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
-
InternalServiceException
–
Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
-
InvalidArnException
–
Indicates that the provided ARN value is not valid.
-
InvalidNextTokenException
–
Indicates that the NextToken value is not valid.
-
LimitExceededException
–
Indicates that limits are exceeded. See Limits for more information.
-
ResourceNotFoundException
–
The specified resource could not be found.
-
RetryableConflictException
–
Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
-
ValidationException
–
Indicates that your request is malformed in some manner. See the exception message.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
To list applied schema ARNs for a specified directory
>>> client.list_applied_schema_arns(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY')
Source code in docs_src/capo_clouddirectory/_services/cloud_directory.py
| def list_applied_schema_arns(
self,
directory_arn: "capo_clouddirectory.types.arn.Arn",
*,
config_overrides: Optional[CloudDirectoryClientConfig] = None,
schema_arn: Optional["capo_clouddirectory.types.arn.Arn"] = None,
next_token: Optional["capo_clouddirectory.types.next_token.NextToken"] = None,
max_results: Optional[
"capo_clouddirectory.types.number_results.NumberResults"
] = None,
) -> "capo_clouddirectory.types.list_applied_schema_arns_response.ListAppliedSchemaArnsResponse":
"""<p>Lists schema major versions applied to a directory. If <code>SchemaArn</code> is provided, lists the minor version.</p>
Args:
directory_arn: <p>The ARN of the directory you are listing.</p>
schema_arn: <p>The response for <code>ListAppliedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>
next_token: <p>The pagination token.</p>
max_results: <p>The maximum number of results to retrieve.</p>
Raises:
capo_clouddirectory.errors.access_denied_exception.AccessDeniedException: <p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>
capo_clouddirectory.errors.internal_service_exception.InternalServiceException: <p>Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the <a href="http://status.aws.amazon.com/">AWS Service Health Dashboard</a> site to see if there are any operational issues with the service.</p>
capo_clouddirectory.errors.invalid_arn_exception.InvalidArnException: <p>Indicates that the provided ARN value is not valid.</p>
capo_clouddirectory.errors.invalid_next_token_exception.InvalidNextTokenException: <p>Indicates that the <code>NextToken</code> value is not valid.</p>
capo_clouddirectory.errors.limit_exceeded_exception.LimitExceededException: <p>Indicates that limits are exceeded. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html">Limits</a> for more information.</p>
capo_clouddirectory.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
capo_clouddirectory.errors.retryable_conflict_exception.RetryableConflictException: <p>Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
capo_clouddirectory.errors.validation_exception.ValidationException: <p>Indicates that your request is malformed in some manner. See the exception message.</p>
capo_clouddirectory.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To list applied schema ARNs for a specified directory
>>> client.list_applied_schema_arns(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY')
"""
def _handler(
req: "OperationRequest[capo_clouddirectory.types.list_applied_schema_arns_request.ListAppliedSchemaArnsRequest]",
) -> OperationResponse[
"capo_clouddirectory.types.list_applied_schema_arns_response.ListAppliedSchemaArnsResponse"
]:
import capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_applied_schema_arns
output, http_response = (
capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_applied_schema_arns.list_applied_schema_arns(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAppliedSchemaArns")
)
input_: capo_clouddirectory.types.list_applied_schema_arns_request.ListAppliedSchemaArnsRequest = {
"directory_arn": directory_arn
}
if schema_arn is not None:
input_["schema_arn"] = schema_arn
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|