Skip to content

list_managed_schema_arns

list_managed_schema_arns(
    *,
    config_overrides: Optional[CloudDirectoryClientConfig] = None,
    schema_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[NumberResults] = None,
) -> ListManagedSchemaArnsResponse

Lists the major version families of each managed 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 ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.

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

    The pagination token.

  • max_results (Optional[NumberResults], default: None ) –

    The maximum number of results to retrieve.

Raises:

Source code in docs_src/capo_clouddirectory/_services/cloud_directory.py
def list_managed_schema_arns(
    self,
    *,
    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_managed_schema_arns_response.ListManagedSchemaArnsResponse":
    """<p>Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.</p>

    Args:
        schema_arn: <p>The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.</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.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</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.
    """

    def _handler(
        req: "OperationRequest[capo_clouddirectory.types.list_managed_schema_arns_request.ListManagedSchemaArnsRequest]",
    ) -> OperationResponse[
        "capo_clouddirectory.types.list_managed_schema_arns_response.ListManagedSchemaArnsResponse"
    ]:
        import capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_managed_schema_arns

        output, http_response = (
            capo_clouddirectory._operations.amazon_cloud_directory_20170111.list_managed_schema_arns.list_managed_schema_arns(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListManagedSchemaArns")
    )
    input_: capo_clouddirectory.types.list_managed_schema_arns_request.ListManagedSchemaArnsRequest = {}
    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