SDK for PHP 3.x

AWS Control Catalog 2018-05-10

Client: Aws\ControlCatalog\ControlCatalogClient
Service ID: controlcatalog
Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS Control Catalog (2018-05-10), and shows how to use the Aws\ControlCatalog\ControlCatalogClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ListCommonControls ( array $params = [] )
Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
ListDomains ( array $params = [] )
Returns a paginated list of domains from the Amazon Web Services Control Catalog.
ListObjectives ( array $params = [] )
Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListCommonControls
ListDomains
ListObjectives

Operations

ListCommonControls 

$result = $client->listCommonControls([/* ... */]);
$promise = $client->listCommonControlsAsync([/* ... */]);

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

Parameter Syntax

$result = $client->listCommonControls([
    'CommonControlFilter' => [
        'Objectives' => [
            [
                'Arn' => '<string>',
            ],
            // ...
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
CommonControlFilter
Type: CommonControlFilter structure

An optional filter that narrows the results to a specific objective.

This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.

MaxResults
Type: int

The maximum number of results on a page or for an API request call.

NextToken
Type: string

The pagination token that's used to fetch the next set of results.

Result Syntax

[
    'CommonControls' => [
        [
            'Arn' => '<string>',
            'CreateTime' => <DateTime>,
            'Description' => '<string>',
            'Domain' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
            'LastUpdateTime' => <DateTime>,
            'Name' => '<string>',
            'Objective' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CommonControls
Required: Yes
Type: Array of CommonControlSummary structures

The list of common controls that the ListCommonControls API returns.

NextToken
Type: string

The pagination token that's used to fetch the next set of results.

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ValidationException:

The request has invalid or missing parameters.

ThrottlingException:

The request was denied due to request throttling.

ListDomains 

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

Parameter Syntax

$result = $client->listDomains([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results on a page or for an API request call.

NextToken
Type: string

The pagination token that's used to fetch the next set of results.

Result Syntax

[
    'Domains' => [
        [
            'Arn' => '<string>',
            'CreateTime' => <DateTime>,
            'Description' => '<string>',
            'LastUpdateTime' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Domains
Required: Yes
Type: Array of DomainSummary structures

The list of domains that the ListDomains API returns.

NextToken
Type: string

The pagination token that's used to fetch the next set of results.

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ValidationException:

The request has invalid or missing parameters.

ThrottlingException:

The request was denied due to request throttling.

ListObjectives 

$result = $client->listObjectives([/* ... */]);
$promise = $client->listObjectivesAsync([/* ... */]);

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

Parameter Syntax

$result = $client->listObjectives([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectiveFilter' => [
        'Domains' => [
            [
                'Arn' => '<string>',
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results on a page or for an API request call.

NextToken
Type: string

The pagination token that's used to fetch the next set of results.

ObjectiveFilter
Type: ObjectiveFilter structure

An optional filter that narrows the results to a specific domain.

This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.

Result Syntax

[
    'NextToken' => '<string>',
    'Objectives' => [
        [
            'Arn' => '<string>',
            'CreateTime' => <DateTime>,
            'Description' => '<string>',
            'Domain' => [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
            'LastUpdateTime' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token that's used to fetch the next set of results.

Objectives
Required: Yes
Type: Array of ObjectiveSummary structures

The list of objectives that the ListObjectives API returns.

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

An internal service error occurred during the processing of your request. Try again later.

ValidationException:

The request has invalid or missing parameters.

ThrottlingException:

The request was denied due to request throttling.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
Message
Type: string

AssociatedDomainSummary

Description

A summary of the domain that a common control or an objective belongs to.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the related domain.

Name
Type: string

The name of the related domain.

AssociatedObjectiveSummary

Description

A summary of the objective that a common control supports.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the related objective.

Name
Type: string

The name of the related objective.

CommonControlFilter

Description

An optional filter that narrows the results to a specific objective.

Members
Objectives
Type: Array of ObjectiveResourceFilter structures

The objective that's used as filter criteria.

You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.

CommonControlSummary

Description

A summary of metadata for a common control.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that identifies the common control.

CreateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the common control was created.

Description
Required: Yes
Type: string

The description of the common control.

Domain
Required: Yes
Type: AssociatedDomainSummary structure

The domain that the common control belongs to.

LastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the common control was most recently updated.

Name
Required: Yes
Type: string

The name of the common control.

Objective
Required: Yes
Type: AssociatedObjectiveSummary structure

The objective that the common control belongs to.

DomainResourceFilter

Description

The domain resource that's being used as a filter.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the domain.

DomainSummary

Description

A summary of metadata for a domain.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that identifies the domain.

CreateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the domain was created.

Description
Required: Yes
Type: string

The description of the domain.

LastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the domain was most recently updated.

Name
Required: Yes
Type: string

The name of the domain.

InternalServerException

Description

An internal service error occurred during the processing of your request. Try again later.

Members
Message
Type: string

ObjectiveFilter

Description

An optional filter that narrows the list of objectives to a specific domain.

Members
Domains
Type: Array of DomainResourceFilter structures

The domain that's used as filter criteria.

You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.

ObjectiveResourceFilter

Description

The objective resource that's being used as a filter.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the objective.

ObjectiveSummary

Description

A summary of metadata for an objective.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that identifies the objective.

CreateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the objective was created.

Description
Required: Yes
Type: string

The description of the objective.

Domain
Required: Yes
Type: AssociatedDomainSummary structure

The domain that the objective belongs to.

LastUpdateTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the objective was most recently updated.

Name
Required: Yes
Type: string

The name of the objective.

ThrottlingException

Description

The request was denied due to request throttling.

Members
Message
Type: string

ValidationException

Description

The request has invalid or missing parameters.

Members
Message
Type: string