Skip to content

list_published_schema_arns async

list_published_schema_arns(
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
    schema_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[NumberResults] = None,
) -> ListPublishedSchemaArnsResponse

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

Parameters:

  • schema_arn (Optional[Arn], default: None ) –

    The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

  • next_token (Optional[NextToken], default: None ) –

    The pagination token.

  • 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.

Source code in docs_src/capo_clouddirectory/_services/async_cloud_directory.py
async def list_published_schema_arns(
    self,
    *,
    config_overrides: Optional[AsyncCloudDirectoryClientConfig] = 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_published_schema_arns_response.ListPublishedSchemaArnsResponse":
    """<p>Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that family are listed instead.</p>

    Args:
        schema_arn: <p>The response for <code>ListPublishedSchemaArns</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_clouddirectory.types.list_published_schema_arns_request.ListPublishedSchemaArnsRequest]",
    ) -> AsyncOperationResponse[
        "capo_clouddirectory.types.list_published_schema_arns_response.ListPublishedSchemaArnsResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_published_schema_arns

        (
            output,
            http_response,
        ) = await capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_published_schema_arns.async_list_published_schema_arns(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPublishedSchemaArns")
    )
    input_: capo_clouddirectory.types.list_published_schema_arns_request.ListPublishedSchemaArnsRequest = {}
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output