AllowVendedLogDeliveryForResource

$result = $client->allowVendedLogDeliveryForResource([/* ... */]);
$promise = $client->allowVendedLogDeliveryForResourceAsync([/* ... */]);

Authorize Ingestion Hub subscription operation. Looks to see if the derived accountId from FAS has an AgentSpace.

Parameter Syntax

$result = $client->allowVendedLogDeliveryForResource([
    'deliverySourceArn' => '<string>', // REQUIRED
    'logType' => '<string>',
    'resourceArnBeingAuthorized' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
]

Result Details

Errors

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

AssociateService

$result = $client->associateService([/* ... */]);
$promise = $client->associateServiceAsync([/* ... */]);

Adds a specific service association to an AgentSpace. It overwrites the existing association of the same service. Returns 201 Created on success.

Parameter Syntax

$result = $client->associateService([
    'agentSpaceId' => '<string>', // REQUIRED
    'configuration' => [ // REQUIRED
        'aws' => [
            'accountId' => '<string>', // REQUIRED
            'accountType' => 'monitor', // REQUIRED
            'assumableRoleArn' => '<string>', // REQUIRED
        ],
        'azure' => [
            'subscriptionId' => '<string>', // REQUIRED
        ],
        'azuredevops' => [
            'organizationName' => '<string>', // REQUIRED
            'projectId' => '<string>', // REQUIRED
            'projectName' => '<string>', // REQUIRED
        ],
        'dynatrace' => [
            'envId' => '<string>', // REQUIRED
            'resources' => ['<string>', ...],
        ],
        'eventChannel' => [
        ],
        'github' => [
            'instanceIdentifier' => '<string>',
            'owner' => '<string>', // REQUIRED
            'ownerType' => 'organization|user', // REQUIRED
            'repoId' => '<string>', // REQUIRED
            'repoName' => '<string>', // REQUIRED
        ],
        'gitlab' => [
            'instanceIdentifier' => '<string>',
            'projectId' => '<string>', // REQUIRED
            'projectPath' => '<string>', // REQUIRED
        ],
        'mcpservergrafana' => [
            'endpoint' => '<string>', // REQUIRED
            'organizationId' => '<string>',
            'tools' => ['<string>', ...],
        ],
        'mcpservernewrelic' => [
            'accountId' => '<string>', // REQUIRED
            'endpoint' => '<string>', // REQUIRED
        ],
        'msteams' => [
            'teamId' => '<string>', // REQUIRED
            'teamName' => '<string>', // REQUIRED
            'transmissionTarget' => [ // REQUIRED
                'opsOncallTarget' => [
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>', // REQUIRED
                ],
                'opsSRETarget' => [
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>', // REQUIRED
                ],
            ],
        ],
        'pagerduty' => [
            'customerEmail' => '<string>', // REQUIRED
            'services' => ['<string>', ...], // REQUIRED
        ],
        'servicenow' => [
            'authScopes' => ['<string>', ...],
            'instanceId' => '<string>',
        ],
        'slack' => [
            'transmissionTarget' => [ // REQUIRED
                'opsOncallTarget' => [ // REQUIRED
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>',
                ],
                'opsSRETarget' => [
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>',
                ],
            ],
            'workspaceId' => '<string>', // REQUIRED
            'workspaceName' => '<string>', // REQUIRED
        ],
        'sourceAws' => [
            'accountId' => '<string>', // REQUIRED
            'accountType' => 'source', // REQUIRED
            'assumableRoleArn' => '<string>', // REQUIRED
            'externalId' => '<string>',
        ],
    ],
    'serviceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'association' => [
        'agentSpaceId' => '<string>',
        'associationId' => '<string>',
        'configuration' => [
            'aws' => [
                'accountId' => '<string>',
                'accountType' => 'monitor',
                'assumableRoleArn' => '<string>',
            ],
            'azure' => [
                'subscriptionId' => '<string>',
            ],
            'azuredevops' => [
                'organizationName' => '<string>',
                'projectId' => '<string>',
                'projectName' => '<string>',
            ],
            'dynatrace' => [
                'envId' => '<string>',
                'resources' => ['<string>', ...],
            ],
            'eventChannel' => [
            ],
            'github' => [
                'instanceIdentifier' => '<string>',
                'owner' => '<string>',
                'ownerType' => 'organization|user',
                'repoId' => '<string>',
                'repoName' => '<string>',
            ],
            'gitlab' => [
                'instanceIdentifier' => '<string>',
                'projectId' => '<string>',
                'projectPath' => '<string>',
            ],
            'mcpservergrafana' => [
                'endpoint' => '<string>',
                'organizationId' => '<string>',
                'tools' => ['<string>', ...],
            ],
            'mcpservernewrelic' => [
                'accountId' => '<string>',
                'endpoint' => '<string>',
            ],
            'msteams' => [
                'teamId' => '<string>',
                'teamName' => '<string>',
                'transmissionTarget' => [
                    'opsOncallTarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                    'opsSRETarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                ],
            ],
            'pagerduty' => [
                'customerEmail' => '<string>',
                'services' => ['<string>', ...],
            ],
            'servicenow' => [
                'authScopes' => ['<string>', ...],
                'instanceId' => '<string>',
            ],
            'slack' => [
                'transmissionTarget' => [
                    'opsOncallTarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                    'opsSRETarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                ],
                'workspaceId' => '<string>',
                'workspaceName' => '<string>',
            ],
            'sourceAws' => [
                'accountId' => '<string>',
                'accountType' => 'source',
                'assumableRoleArn' => '<string>',
                'externalId' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'serviceId' => '<string>',
        'status' => 'valid|invalid|pending-confirmation',
        'updatedAt' => <DateTime>,
    ],
    'webhook' => [
        'apiKey' => '<string>',
        'webhookId' => '<string>',
        'webhookSecret' => '<string>',
        'webhookType' => 'hmac|apikey|gitlab|pagerduty',
        'webhookUrl' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

CreateAgentSpace

$result = $client->createAgentSpace([/* ... */]);
$promise = $client->createAgentSpaceAsync([/* ... */]);

Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.

Parameter Syntax

$result = $client->createAgentSpace([
    'clientToken' => '<string>',
    'description' => '<string>',
    'kmsKeyArn' => '<string>',
    'locale' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'agentSpace' => [
        'agentSpaceId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'kmsKeyArn' => '<string>',
        'locale' => '<string>',
        'name' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ResourceNotFoundException:

The requested resource could not be found.

CreateBacklogTask

$result = $client->createBacklogTask([/* ... */]);
$promise = $client->createBacklogTaskAsync([/* ... */]);

Creates a new backlog task in the specified agent space

Parameter Syntax

$result = $client->createBacklogTask([
    'agentSpaceId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'priority' => 'CRITICAL|HIGH|MEDIUM|LOW|MINIMAL', // REQUIRED
    'reference' => [
        'associationId' => '<string>', // REQUIRED
        'referenceId' => '<string>', // REQUIRED
        'referenceUrl' => '<string>', // REQUIRED
        'system' => '<string>', // REQUIRED
        'title' => '<string>',
    ],
    'taskType' => 'INVESTIGATION|EVALUATION', // REQUIRED
    'title' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'task' => [
        'agentSpaceId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'executionId' => '<string>',
        'hasLinkedTasks' => true || false,
        'metadata' => [
        ],
        'primaryTaskId' => '<string>',
        'priority' => 'CRITICAL|HIGH|MEDIUM|LOW|MINIMAL',
        'reference' => [
            'associationId' => '<string>',
            'referenceId' => '<string>',
            'referenceUrl' => '<string>',
            'system' => '<string>',
            'title' => '<string>',
        ],
        'status' => 'PENDING_TRIAGE|LINKED|PENDING_START|IN_PROGRESS|PENDING_CUSTOMER_APPROVAL|COMPLETED|FAILED|TIMED_OUT|CANCELED',
        'statusReason' => '<string>',
        'supportMetadata' => [
        ],
        'taskId' => '<string>',
        'taskType' => 'INVESTIGATION|EVALUATION',
        'title' => '<string>',
        'updatedAt' => <DateTime>,
        'version' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

CreateChat

$result = $client->createChat([/* ... */]);
$promise = $client->createChatAsync([/* ... */]);

Creates a new chat execution in the specified agent space

Parameter Syntax

$result = $client->createChat([
    'agentSpaceId' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
    'userType' => 'IAM|IDC|IDP',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'executionId' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

CreatePrivateConnection

$result = $client->createPrivateConnection([/* ... */]);
$promise = $client->createPrivateConnectionAsync([/* ... */]);

Creates a Private Connection to a target resource.

Parameter Syntax

$result = $client->createPrivateConnection([
    'mode' => [ // REQUIRED
        'selfManaged' => [
            'certificate' => '<string>',
            'resourceConfigurationId' => '<string>', // REQUIRED
        ],
        'serviceManaged' => [
            'certificate' => '<string>',
            'hostAddress' => '<string>', // REQUIRED
            'ipAddressType' => 'IPV4|IPV6|DUAL_STACK',
            'ipv4AddressesPerEni' => <integer>,
            'portRanges' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...], // REQUIRED
            'vpcId' => '<string>', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'certificateExpiryTime' => <DateTime>,
    'hostAddress' => '<string>',
    'name' => '<string>',
    'resourceConfigurationId' => '<string>',
    'resourceGatewayId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'tags' => ['<string>', ...],
    'type' => 'SELF_MANAGED|SERVICE_MANAGED',
    'vpcId' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DeleteAgentSpace

$result = $client->deleteAgentSpace([/* ... */]);
$promise = $client->deleteAgentSpaceAsync([/* ... */]);

Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

Parameter Syntax

$result = $client->deleteAgentSpace([
    'agentSpaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DeletePrivateConnection

$result = $client->deletePrivateConnection([/* ... */]);
$promise = $client->deletePrivateConnectionAsync([/* ... */]);

Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.

Parameter Syntax

$result = $client->deletePrivateConnection([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'name' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DeregisterService

$result = $client->deregisterService([/* ... */]);
$promise = $client->deregisterServiceAsync([/* ... */]);

Deregister a service

Parameter Syntax

$result = $client->deregisterService([
    'serviceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DescribePrivateConnection

$result = $client->describePrivateConnection([/* ... */]);
$promise = $client->describePrivateConnectionAsync([/* ... */]);

Retrieves details of an existing Private Connection.

Parameter Syntax

$result = $client->describePrivateConnection([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'certificateExpiryTime' => <DateTime>,
    'hostAddress' => '<string>',
    'name' => '<string>',
    'resourceConfigurationId' => '<string>',
    'resourceGatewayId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'tags' => ['<string>', ...],
    'type' => 'SELF_MANAGED|SERVICE_MANAGED',
    'vpcId' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DescribeSupportLevel

$result = $client->describeSupportLevel([/* ... */]);
$promise = $client->describeSupportLevelAsync([/* ... */]);

Describe the support level of a CloudSmith customer account.

Parameter Syntax

$result = $client->describeSupportLevel([
    'agentSpaceId' => '<string>', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'activeSubscription' => true || false,
    'mosaicSupportLevel' => [
        'code' => '<string>',
        'name' => '<string>',
    ],
    'supportLevel' => [
        'code' => '<string>',
        'name' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DisableOperatorApp

$result = $client->disableOperatorApp([/* ... */]);
$promise = $client->disableOperatorAppAsync([/* ... */]);

Disable the Operator App for the specified AgentSpace

Parameter Syntax

$result = $client->disableOperatorApp([
    'agentSpaceId' => '<string>', // REQUIRED
    'authFlow' => 'iam|idc|idp',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

IdentityCenterServiceException:

Calls to the customer Identity Center have failed

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

DisassociateService

$result = $client->disassociateService([/* ... */]);
$promise = $client->disassociateServiceAsync([/* ... */]);

Deletes a specific service association from an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

Parameter Syntax

$result = $client->disassociateService([
    'agentSpaceId' => '<string>', // REQUIRED
    'associationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

EnableOperatorApp

$result = $client->enableOperatorApp([/* ... */]);
$promise = $client->enableOperatorAppAsync([/* ... */]);

Enable the Operator App to access the given AgentSpace

Parameter Syntax

$result = $client->enableOperatorApp([
    'agentSpaceId' => '<string>', // REQUIRED
    'authFlow' => 'iam|idc|idp', // REQUIRED
    'idcInstanceArn' => '<string>',
    'idpClientId' => '<string>',
    'idpClientSecret' => '<string>',
    'issuerUrl' => '<string>',
    'operatorAppRoleArn' => '<string>', // REQUIRED
    'provider' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'iam' => [
        'createdAt' => <DateTime>,
        'operatorAppRoleArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'idc' => [
        'createdAt' => <DateTime>,
        'idcApplicationArn' => '<string>',
        'idcInstanceArn' => '<string>',
        'operatorAppRoleArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'idp' => [
        'clientId' => '<string>',
        'createdAt' => <DateTime>,
        'issuerUrl' => '<string>',
        'operatorAppRoleArn' => '<string>',
        'provider' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

IdentityCenterServiceException:

Calls to the customer Identity Center have failed

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

EndChatForCase

$result = $client->endChatForCase([/* ... */]);
$promise = $client->endChatForCaseAsync([/* ... */]);

End a chat session for a support case in the specified agent space

Parameter Syntax

$result = $client->endChatForCase([
    'agentSpaceId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'reason' => '<string>',
    'requester' => '<string>',
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errorMessage' => '<string>',
    'executionId' => '<string>',
    'isDisconnected' => true || false,
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetAccountUsage

$result = $client->getAccountUsage([/* ... */]);
$promise = $client->getAccountUsageAsync([/* ... */]);

Retrieves monthly account usage metrics and limits for the AWS account.

Parameter Syntax

$result = $client->getAccountUsage([
]);

Parameter Details

Result Syntax

[
    'monthlyAccountEvaluationHours' => [
        'limit' => <integer>,
        'usage' => <float>,
    ],
    'monthlyAccountInvestigationHours' => [
        'limit' => <integer>,
        'usage' => <float>,
    ],
    'monthlyAccountSystemLearningHours' => [
        'limit' => <integer>,
        'usage' => <float>,
    ],
    'usagePeriodEndTime' => <DateTime>,
    'usagePeriodStartTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetAgentSpace

$result = $client->getAgentSpace([/* ... */]);
$promise = $client->getAgentSpaceAsync([/* ... */]);

Retrieves detailed information about a specific AgentSpace.

Parameter Syntax

$result = $client->getAgentSpace([
    'agentSpaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentSpace' => [
        'agentSpaceId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'kmsKeyArn' => '<string>',
        'locale' => '<string>',
        'name' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetAssociation

$result = $client->getAssociation([/* ... */]);
$promise = $client->getAssociationAsync([/* ... */]);

Retrieves given associations configured for a specific AgentSpace.

Parameter Syntax

$result = $client->getAssociation([
    'agentSpaceId' => '<string>', // REQUIRED
    'associationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'association' => [
        'agentSpaceId' => '<string>',
        'associationId' => '<string>',
        'configuration' => [
            'aws' => [
                'accountId' => '<string>',
                'accountType' => 'monitor',
                'assumableRoleArn' => '<string>',
            ],
            'azure' => [
                'subscriptionId' => '<string>',
            ],
            'azuredevops' => [
                'organizationName' => '<string>',
                'projectId' => '<string>',
                'projectName' => '<string>',
            ],
            'dynatrace' => [
                'envId' => '<string>',
                'resources' => ['<string>', ...],
            ],
            'eventChannel' => [
            ],
            'github' => [
                'instanceIdentifier' => '<string>',
                'owner' => '<string>',
                'ownerType' => 'organization|user',
                'repoId' => '<string>',
                'repoName' => '<string>',
            ],
            'gitlab' => [
                'instanceIdentifier' => '<string>',
                'projectId' => '<string>',
                'projectPath' => '<string>',
            ],
            'mcpservergrafana' => [
                'endpoint' => '<string>',
                'organizationId' => '<string>',
                'tools' => ['<string>', ...],
            ],
            'mcpservernewrelic' => [
                'accountId' => '<string>',
                'endpoint' => '<string>',
            ],
            'msteams' => [
                'teamId' => '<string>',
                'teamName' => '<string>',
                'transmissionTarget' => [
                    'opsOncallTarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                    'opsSRETarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                ],
            ],
            'pagerduty' => [
                'customerEmail' => '<string>',
                'services' => ['<string>', ...],
            ],
            'servicenow' => [
                'authScopes' => ['<string>', ...],
                'instanceId' => '<string>',
            ],
            'slack' => [
                'transmissionTarget' => [
                    'opsOncallTarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                    'opsSRETarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                ],
                'workspaceId' => '<string>',
                'workspaceName' => '<string>',
            ],
            'sourceAws' => [
                'accountId' => '<string>',
                'accountType' => 'source',
                'assumableRoleArn' => '<string>',
                'externalId' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'serviceId' => '<string>',
        'status' => 'valid|invalid|pending-confirmation',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetBacklogTask

$result = $client->getBacklogTask([/* ... */]);
$promise = $client->getBacklogTaskAsync([/* ... */]);

Gets a backlog task for the specified agent space and task id

Parameter Syntax

$result = $client->getBacklogTask([
    'agentSpaceId' => '<string>', // REQUIRED
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'task' => [
        'agentSpaceId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'executionId' => '<string>',
        'hasLinkedTasks' => true || false,
        'metadata' => [
        ],
        'primaryTaskId' => '<string>',
        'priority' => 'CRITICAL|HIGH|MEDIUM|LOW|MINIMAL',
        'reference' => [
            'associationId' => '<string>',
            'referenceId' => '<string>',
            'referenceUrl' => '<string>',
            'system' => '<string>',
            'title' => '<string>',
        ],
        'status' => 'PENDING_TRIAGE|LINKED|PENDING_START|IN_PROGRESS|PENDING_CUSTOMER_APPROVAL|COMPLETED|FAILED|TIMED_OUT|CANCELED',
        'statusReason' => '<string>',
        'supportMetadata' => [
        ],
        'taskId' => '<string>',
        'taskType' => 'INVESTIGATION|EVALUATION',
        'title' => '<string>',
        'updatedAt' => <DateTime>,
        'version' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetOperatorApp

$result = $client->getOperatorApp([/* ... */]);
$promise = $client->getOperatorAppAsync([/* ... */]);

Get the full auth configuration of operator including any enabled auth flow

Parameter Syntax

$result = $client->getOperatorApp([
    'agentSpaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'iam' => [
        'createdAt' => <DateTime>,
        'operatorAppRoleArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'idc' => [
        'createdAt' => <DateTime>,
        'idcApplicationArn' => '<string>',
        'idcInstanceArn' => '<string>',
        'operatorAppRoleArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
    'idp' => [
        'clientId' => '<string>',
        'createdAt' => <DateTime>,
        'issuerUrl' => '<string>',
        'operatorAppRoleArn' => '<string>',
        'provider' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetRecommendation

$result = $client->getRecommendation([/* ... */]);
$promise = $client->getRecommendationAsync([/* ... */]);

Retrieves a specific recommendation by its ID

Parameter Syntax

$result = $client->getRecommendation([
    'agentSpaceId' => '<string>', // REQUIRED
    'recommendationId' => '<string>', // REQUIRED
    'recommendationVersion' => <integer>,
]);

Parameter Details

Result Syntax

[
    'recommendation' => [
        'additionalContext' => '<string>',
        'agentSpaceArn' => '<string>',
        'content' => [
            'spec' => '<string>',
            'summary' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'goalId' => '<string>',
        'goalVersion' => <integer>,
        'priority' => 'HIGH|MEDIUM|LOW',
        'recommendationId' => '<string>',
        'status' => 'PROPOSED|ACCEPTED|REJECTED|CLOSED|COMPLETED|UPDATE_IN_PROGRESS',
        'taskId' => '<string>',
        'title' => '<string>',
        'updatedAt' => <DateTime>,
        'version' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

GetService

$result = $client->getService([/* ... */]);
$promise = $client->getServiceAsync([/* ... */]);

Retrieves given service by it's unique identifier

Parameter Syntax

$result = $client->getService([
    'serviceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'service' => [
        'accessibleResources' => [
            [
            ],
            // ...
        ],
        'additionalServiceDetails' => [
            'azuredevops' => [
                'organizationName' => '<string>',
            ],
            'azureidentity' => [
                'clientId' => '<string>',
                'tenantId' => '<string>',
                'webIdentityRoleArn' => '<string>',
                'webIdentityTokenAudiences' => ['<string>', ...],
            ],
            'github' => [
                'owner' => '<string>',
                'ownerType' => 'organization|user',
                'targetUrl' => '<string>',
            ],
            'gitlab' => [
                'groupId' => '<string>',
                'targetUrl' => '<string>',
                'tokenType' => 'personal|group',
            ],
            'mcpserver' => [
                'apiKeyHeader' => '<string>',
                'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                'description' => '<string>',
                'endpoint' => '<string>',
                'name' => '<string>',
            ],
            'mcpserverdatadog' => [
                'apiKeyHeader' => '<string>',
                'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                'description' => '<string>',
                'endpoint' => '<string>',
                'name' => '<string>',
            ],
            'mcpservergrafana' => [
                'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                'endpoint' => '<string>',
            ],
            'mcpservernewrelic' => [
                'accountId' => '<string>',
                'description' => '<string>',
                'region' => 'US|EU',
            ],
            'mcpserversigv4' => [
                'description' => '<string>',
                'endpoint' => '<string>',
                'name' => '<string>',
                'region' => '<string>',
                'roleArn' => '<string>',
                'service' => '<string>',
            ],
            'mcpserversplunk' => [
                'apiKeyHeader' => '<string>',
                'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                'description' => '<string>',
                'endpoint' => '<string>',
                'name' => '<string>',
            ],
            'pagerduty' => [
                'scopes' => ['<string>', ...],
            ],
            'servicenow' => [
                'instanceUrl' => '<string>',
            ],
            'slack' => [
                'teamId' => '<string>',
                'teamName' => '<string>',
            ],
        ],
        'kmsKeyArn' => '<string>',
        'name' => '<string>',
        'privateConnectionName' => '<string>',
        'serviceId' => '<string>',
        'serviceType' => 'github|slack|azure|azuredevops|msteams|dynatrace|servicenow|pagerduty|gitlab|eventChannel|mcpservernewrelic|mcpservergrafana|mcpserverdatadog|mcpserver|mcpserversplunk|azureidentity|mcpserversigv4',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

InitiateChatForCase

$result = $client->initiateChatForCase([/* ... */]);
$promise = $client->initiateChatForCaseAsync([/* ... */]);

Initiate a chat for support case in the specified agent space

Parameter Syntax

$result = $client->initiateChatForCase([
    'agentSpaceId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'chatParticipantConnection' => [
        'initialContactId' => '<string>',
        'participantId' => '<string>',
        'participantToken' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListAgentSpaces

$result = $client->listAgentSpaces([/* ... */]);
$promise = $client->listAgentSpacesAsync([/* ... */]);

Lists all AgentSpaces with optional pagination.

Parameter Syntax

$result = $client->listAgentSpaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentSpaces' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'kmsKeyArn' => '<string>',
            'locale' => '<string>',
            'name' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListAssociations

$result = $client->listAssociations([/* ... */]);
$promise = $client->listAssociationsAsync([/* ... */]);

List all associations for given AgentSpace

Parameter Syntax

$result = $client->listAssociations([
    'agentSpaceId' => '<string>', // REQUIRED
    'filterServiceTypes' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'associations' => [
        [
            'agentSpaceId' => '<string>',
            'associationId' => '<string>',
            'configuration' => [
                'aws' => [
                    'accountId' => '<string>',
                    'accountType' => 'monitor',
                    'assumableRoleArn' => '<string>',
                ],
                'azure' => [
                    'subscriptionId' => '<string>',
                ],
                'azuredevops' => [
                    'organizationName' => '<string>',
                    'projectId' => '<string>',
                    'projectName' => '<string>',
                ],
                'dynatrace' => [
                    'envId' => '<string>',
                    'resources' => ['<string>', ...],
                ],
                'eventChannel' => [
                ],
                'github' => [
                    'instanceIdentifier' => '<string>',
                    'owner' => '<string>',
                    'ownerType' => 'organization|user',
                    'repoId' => '<string>',
                    'repoName' => '<string>',
                ],
                'gitlab' => [
                    'instanceIdentifier' => '<string>',
                    'projectId' => '<string>',
                    'projectPath' => '<string>',
                ],
                'mcpservergrafana' => [
                    'endpoint' => '<string>',
                    'organizationId' => '<string>',
                    'tools' => ['<string>', ...],
                ],
                'mcpservernewrelic' => [
                    'accountId' => '<string>',
                    'endpoint' => '<string>',
                ],
                'msteams' => [
                    'teamId' => '<string>',
                    'teamName' => '<string>',
                    'transmissionTarget' => [
                        'opsOncallTarget' => [
                            'channelId' => '<string>',
                            'channelName' => '<string>',
                        ],
                        'opsSRETarget' => [
                            'channelId' => '<string>',
                            'channelName' => '<string>',
                        ],
                    ],
                ],
                'pagerduty' => [
                    'customerEmail' => '<string>',
                    'services' => ['<string>', ...],
                ],
                'servicenow' => [
                    'authScopes' => ['<string>', ...],
                    'instanceId' => '<string>',
                ],
                'slack' => [
                    'transmissionTarget' => [
                        'opsOncallTarget' => [
                            'channelId' => '<string>',
                            'channelName' => '<string>',
                        ],
                        'opsSRETarget' => [
                            'channelId' => '<string>',
                            'channelName' => '<string>',
                        ],
                    ],
                    'workspaceId' => '<string>',
                    'workspaceName' => '<string>',
                ],
                'sourceAws' => [
                    'accountId' => '<string>',
                    'accountType' => 'source',
                    'assumableRoleArn' => '<string>',
                    'externalId' => '<string>',
                ],
            ],
            'createdAt' => <DateTime>,
            'serviceId' => '<string>',
            'status' => 'valid|invalid|pending-confirmation',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListBacklogTasks

$result = $client->listBacklogTasks([/* ... */]);
$promise = $client->listBacklogTasksAsync([/* ... */]);

Lists backlog tasks in the specified agent space with optional filtering and sorting

Parameter Syntax

$result = $client->listBacklogTasks([
    'agentSpaceId' => '<string>', // REQUIRED
    'filter' => [
        'createdAfter' => <integer || string || DateTime>,
        'createdBefore' => <integer || string || DateTime>,
        'primaryTaskId' => '<string>',
        'priority' => ['<string>', ...],
        'status' => ['<string>', ...],
        'taskType' => ['<string>', ...],
    ],
    'limit' => <integer>,
    'nextToken' => '<string>',
    'order' => 'ASC|DESC',
    'sortField' => 'CREATED_AT|PRIORITY',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tasks' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'executionId' => '<string>',
            'hasLinkedTasks' => true || false,
            'metadata' => [
            ],
            'primaryTaskId' => '<string>',
            'priority' => 'CRITICAL|HIGH|MEDIUM|LOW|MINIMAL',
            'reference' => [
                'associationId' => '<string>',
                'referenceId' => '<string>',
                'referenceUrl' => '<string>',
                'system' => '<string>',
                'title' => '<string>',
            ],
            'status' => 'PENDING_TRIAGE|LINKED|PENDING_START|IN_PROGRESS|PENDING_CUSTOMER_APPROVAL|COMPLETED|FAILED|TIMED_OUT|CANCELED',
            'statusReason' => '<string>',
            'supportMetadata' => [
            ],
            'taskId' => '<string>',
            'taskType' => 'INVESTIGATION|EVALUATION',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListChats

$result = $client->listChats([/* ... */]);
$promise = $client->listChatsAsync([/* ... */]);

Retrieves a paginated list of the user's recent chat executions

Parameter Syntax

$result = $client->listChats([
    'agentSpaceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'executions' => [
        [
            'createdAt' => <DateTime>,
            'executionId' => '<string>',
            'summary' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListExecutions

$result = $client->listExecutions([/* ... */]);
$promise = $client->listExecutionsAsync([/* ... */]);

List executions

Parameter Syntax

$result = $client->listExecutions([
    'agentSpaceId' => '<string>', // REQUIRED
    'limit' => <integer>,
    'nextToken' => '<string>',
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'executions' => [
        [
            'agentSpaceId' => '<string>',
            'agentSubTask' => '<string>',
            'agentType' => '<string>',
            'createdAt' => <DateTime>,
            'executionId' => '<string>',
            'executionStatus' => 'FAILED|RUNNING|STOPPED|CANCELED|TIMED_OUT',
            'parentExecutionId' => '<string>',
            'uid' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListGoals

$result = $client->listGoals([/* ... */]);
$promise = $client->listGoalsAsync([/* ... */]);

Lists goals in the specified agent space with optional filtering

Parameter Syntax

$result = $client->listGoals([
    'agentSpaceId' => '<string>', // REQUIRED
    'goalType' => 'CUSTOMER_DEFINED|ONCALL_REPORT',
    'limit' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|PAUSED|COMPLETE',
]);

Parameter Details

Result Syntax

[
    'goals' => [
        [
            'agentSpaceArn' => '<string>',
            'content' => [
                'description' => '<string>',
                'objectives' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'evaluationSchedule' => [
                'expression' => '<string>',
                'state' => 'ENABLED|DISABLED',
            ],
            'goalId' => '<string>',
            'goalType' => 'CUSTOMER_DEFINED|ONCALL_REPORT',
            'lastEvaluatedAt' => <DateTime>,
            'lastSuccessfulTaskId' => '<string>',
            'lastTaskId' => '<string>',
            'status' => 'ACTIVE|PAUSED|COMPLETE',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'version' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListJournalRecords

$result = $client->listJournalRecords([/* ... */]);
$promise = $client->listJournalRecordsAsync([/* ... */]);

List journal records for a specific execution

Parameter Syntax

$result = $client->listJournalRecords([
    'agentSpaceId' => '<string>', // REQUIRED
    'executionId' => '<string>', // REQUIRED
    'limit' => <integer>,
    'nextToken' => '<string>',
    'order' => 'ASC|DESC',
    'recordType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'records' => [
        [
            'agentSpaceId' => '<string>',
            'content' => [
            ],
            'createdAt' => <DateTime>,
            'executionId' => '<string>',
            'recordId' => '<string>',
            'recordType' => '<string>',
            'userReference' => [
                'userId' => '<string>',
                'userType' => 'IAM|IDC|IDP',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListPendingMessages

$result = $client->listPendingMessages([/* ... */]);
$promise = $client->listPendingMessagesAsync([/* ... */]);

List pending messages for a specific execution.

Parameter Syntax

$result = $client->listPendingMessages([
    'agentSpaceId' => '<string>', // REQUIRED
    'executionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'createdAt' => <DateTime>,
    'executionId' => '<string>',
    'messages' => [
        [
            'message' => [
                'assistantMessage' => [
                    [
                        'text' => '<string>',
                        'toolUse' => [
                        ],
                    ],
                    // ...
                ],
                'userMessage' => [
                    [
                        'text' => '<string>',
                        'toolResult' => [
                        ],
                    ],
                    // ...
                ],
            ],
            'messageId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListPrivateConnections

$result = $client->listPrivateConnections([/* ... */]);
$promise = $client->listPrivateConnectionsAsync([/* ... */]);

Lists all Private Connections in the caller's account.

Parameter Syntax

$result = $client->listPrivateConnections([
]);

Parameter Details

Result Syntax

[
    'privateConnections' => [
        [
            'certificateExpiryTime' => <DateTime>,
            'hostAddress' => '<string>',
            'name' => '<string>',
            'resourceConfigurationId' => '<string>',
            'resourceGatewayId' => '<string>',
            'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
            'type' => 'SELF_MANAGED|SERVICE_MANAGED',
            'vpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListRecommendations

$result = $client->listRecommendations([/* ... */]);
$promise = $client->listRecommendationsAsync([/* ... */]);

Lists recommendations for the specified agent space

Parameter Syntax

$result = $client->listRecommendations([
    'agentSpaceId' => '<string>', // REQUIRED
    'goalId' => '<string>',
    'limit' => <integer>,
    'nextToken' => '<string>',
    'priority' => 'HIGH|MEDIUM|LOW',
    'status' => 'PROPOSED|ACCEPTED|REJECTED|CLOSED|COMPLETED|UPDATE_IN_PROGRESS',
    'taskId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recommendations' => [
        [
            'additionalContext' => '<string>',
            'agentSpaceArn' => '<string>',
            'content' => [
                'spec' => '<string>',
                'summary' => '<string>',
            ],
            'createdAt' => <DateTime>,
            'goalId' => '<string>',
            'goalVersion' => <integer>,
            'priority' => 'HIGH|MEDIUM|LOW',
            'recommendationId' => '<string>',
            'status' => 'PROPOSED|ACCEPTED|REJECTED|CLOSED|COMPLETED|UPDATE_IN_PROGRESS',
            'taskId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListServices

$result = $client->listServices([/* ... */]);
$promise = $client->listServicesAsync([/* ... */]);

List a list of registered service on the account level.

Parameter Syntax

$result = $client->listServices([
    'filterServiceType' => 'github|slack|azure|azuredevops|msteams|dynatrace|servicenow|pagerduty|gitlab|eventChannel|mcpservernewrelic|mcpservergrafana|mcpserverdatadog|mcpserver|mcpserversplunk|azureidentity|mcpserversigv4',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'services' => [
        [
            'accessibleResources' => [
                [
                ],
                // ...
            ],
            'additionalServiceDetails' => [
                'azuredevops' => [
                    'organizationName' => '<string>',
                ],
                'azureidentity' => [
                    'clientId' => '<string>',
                    'tenantId' => '<string>',
                    'webIdentityRoleArn' => '<string>',
                    'webIdentityTokenAudiences' => ['<string>', ...],
                ],
                'github' => [
                    'owner' => '<string>',
                    'ownerType' => 'organization|user',
                    'targetUrl' => '<string>',
                ],
                'gitlab' => [
                    'groupId' => '<string>',
                    'targetUrl' => '<string>',
                    'tokenType' => 'personal|group',
                ],
                'mcpserver' => [
                    'apiKeyHeader' => '<string>',
                    'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                    'description' => '<string>',
                    'endpoint' => '<string>',
                    'name' => '<string>',
                ],
                'mcpserverdatadog' => [
                    'apiKeyHeader' => '<string>',
                    'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                    'description' => '<string>',
                    'endpoint' => '<string>',
                    'name' => '<string>',
                ],
                'mcpservergrafana' => [
                    'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                    'endpoint' => '<string>',
                ],
                'mcpservernewrelic' => [
                    'accountId' => '<string>',
                    'description' => '<string>',
                    'region' => 'US|EU',
                ],
                'mcpserversigv4' => [
                    'description' => '<string>',
                    'endpoint' => '<string>',
                    'name' => '<string>',
                    'region' => '<string>',
                    'roleArn' => '<string>',
                    'service' => '<string>',
                ],
                'mcpserversplunk' => [
                    'apiKeyHeader' => '<string>',
                    'authorizationMethod' => 'oauth-client-credentials|oauth-3lo|api-key|bearer-token',
                    'description' => '<string>',
                    'endpoint' => '<string>',
                    'name' => '<string>',
                ],
                'pagerduty' => [
                    'scopes' => ['<string>', ...],
                ],
                'servicenow' => [
                    'instanceUrl' => '<string>',
                ],
                'slack' => [
                    'teamId' => '<string>',
                    'teamName' => '<string>',
                ],
            ],
            'kmsKeyArn' => '<string>',
            'name' => '<string>',
            'privateConnectionName' => '<string>',
            'serviceId' => '<string>',
            'serviceType' => 'github|slack|azure|azuredevops|msteams|dynatrace|servicenow|pagerduty|gitlab|eventChannel|mcpservernewrelic|mcpservergrafana|mcpserverdatadog|mcpserver|mcpserversplunk|azureidentity|mcpserversigv4',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for the specified AWS DevOps Agent resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ListWebhooks

$result = $client->listWebhooks([/* ... */]);
$promise = $client->listWebhooksAsync([/* ... */]);

List all webhooks for given Association

Parameter Syntax

$result = $client->listWebhooks([
    'agentSpaceId' => '<string>', // REQUIRED
    'associationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'webhooks' => [
        [
            'webhookId' => '<string>',
            'webhookType' => 'hmac|apikey|gitlab|pagerduty',
            'webhookUrl' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

RegisterService

$result = $client->registerService([/* ... */]);
$promise = $client->registerServiceAsync([/* ... */]);

This operation registers the specified service

Parameter Syntax

$result = $client->registerService([
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'privateConnectionName' => '<string>',
    'service' => 'dynatrace|servicenow|pagerduty|gitlab|eventChannel|mcpservernewrelic|mcpservergrafana|mcpserverdatadog|mcpserver|mcpserversplunk|azureidentity|mcpserversigv4', // REQUIRED
    'serviceDetails' => [ // REQUIRED
        'azureidentity' => [
            'clientId' => '<string>', // REQUIRED
            'tenantId' => '<string>', // REQUIRED
            'webIdentityRoleArn' => '<string>', // REQUIRED
            'webIdentityTokenAudiences' => ['<string>', ...], // REQUIRED
        ],
        'dynatrace' => [
            'accountUrn' => '<string>', // REQUIRED
            'authorizationConfig' => [
                'oAuthClientCredentials' => [
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>', // REQUIRED
                    'exchangeParameters' => ['<string>', ...],
                ],
            ],
        ],
        'eventChannel' => [
            'type' => 'webhook',
        ],
        'gitlab' => [
            'groupId' => '<string>',
            'targetUrl' => '<string>', // REQUIRED
            'tokenType' => 'personal|group', // REQUIRED
            'tokenValue' => '<string>', // REQUIRED
        ],
        'mcpserver' => [
            'authorizationConfig' => [ // REQUIRED
                'apiKey' => [
                    'apiKeyHeader' => '<string>', // REQUIRED
                    'apiKeyName' => '<string>', // REQUIRED
                    'apiKeyValue' => '<string>', // REQUIRED
                ],
                'authorizationDiscovery' => [
                    'returnToEndpoint' => '<string>', // REQUIRED
                ],
                'bearerToken' => [
                    'authorizationHeader' => '<string>',
                    'tokenName' => '<string>', // REQUIRED
                    'tokenValue' => '<string>', // REQUIRED
                ],
                'oAuth3LO' => [
                    'authorizationUrl' => '<string>', // REQUIRED
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>',
                    'exchangeParameters' => ['<string>', ...],
                    'exchangeUrl' => '<string>', // REQUIRED
                    'returnToEndpoint' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...],
                    'supportCodeChallenge' => true || false,
                ],
                'oAuthClientCredentials' => [
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>', // REQUIRED
                    'exchangeParameters' => ['<string>', ...],
                    'exchangeUrl' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...],
                ],
            ],
            'description' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        'mcpserverdatadog' => [
            'authorizationConfig' => [ // REQUIRED
                'authorizationDiscovery' => [
                    'returnToEndpoint' => '<string>', // REQUIRED
                ],
            ],
            'description' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        'mcpservergrafana' => [
            'authorizationConfig' => [ // REQUIRED
                'apiKey' => [
                    'apiKeyHeader' => '<string>', // REQUIRED
                    'apiKeyName' => '<string>', // REQUIRED
                    'apiKeyValue' => '<string>', // REQUIRED
                ],
                'authorizationDiscovery' => [
                    'returnToEndpoint' => '<string>', // REQUIRED
                ],
                'bearerToken' => [
                    'authorizationHeader' => '<string>',
                    'tokenName' => '<string>', // REQUIRED
                    'tokenValue' => '<string>', // REQUIRED
                ],
                'oAuth3LO' => [
                    'authorizationUrl' => '<string>', // REQUIRED
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>',
                    'exchangeParameters' => ['<string>', ...],
                    'exchangeUrl' => '<string>', // REQUIRED
                    'returnToEndpoint' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...],
                    'supportCodeChallenge' => true || false,
                ],
                'oAuthClientCredentials' => [
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>', // REQUIRED
                    'exchangeParameters' => ['<string>', ...],
                    'exchangeUrl' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...],
                ],
            ],
            'description' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        'mcpservernewrelic' => [
            'authorizationConfig' => [ // REQUIRED
                'apiKey' => [
                    'accountId' => '<string>', // REQUIRED
                    'alertPolicyIds' => ['<string>', ...],
                    'apiKey' => '<string>', // REQUIRED
                    'applicationIds' => ['<string>', ...],
                    'entityGuids' => ['<string>', ...],
                    'region' => 'US|EU', // REQUIRED
                ],
            ],
        ],
        'mcpserversigv4' => [
            'authorizationConfig' => [ // REQUIRED
                'region' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
                'service' => '<string>', // REQUIRED
            ],
            'description' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        'mcpserversplunk' => [
            'authorizationConfig' => [ // REQUIRED
                'apiKey' => [
                    'apiKeyHeader' => '<string>', // REQUIRED
                    'apiKeyName' => '<string>', // REQUIRED
                    'apiKeyValue' => '<string>', // REQUIRED
                ],
                'authorizationDiscovery' => [
                    'returnToEndpoint' => '<string>', // REQUIRED
                ],
                'bearerToken' => [
                    'authorizationHeader' => '<string>',
                    'tokenName' => '<string>', // REQUIRED
                    'tokenValue' => '<string>', // REQUIRED
                ],
                'oAuth3LO' => [
                    'authorizationUrl' => '<string>', // REQUIRED
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>',
                    'exchangeParameters' => ['<string>', ...],
                    'exchangeUrl' => '<string>', // REQUIRED
                    'returnToEndpoint' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...],
                    'supportCodeChallenge' => true || false,
                ],
                'oAuthClientCredentials' => [
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>', // REQUIRED
                    'exchangeParameters' => ['<string>', ...],
                    'exchangeUrl' => '<string>', // REQUIRED
                    'scopes' => ['<string>', ...],
                ],
            ],
            'description' => '<string>',
            'endpoint' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        'pagerduty' => [
            'authorizationConfig' => [ // REQUIRED
                'oAuthClientCredentials' => [
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>', // REQUIRED
                    'exchangeParameters' => ['<string>', ...],
                ],
            ],
            'scopes' => ['<string>', ...], // REQUIRED
        ],
        'servicenow' => [
            'authorizationConfig' => [
                'oAuthClientCredentials' => [
                    'clientId' => '<string>', // REQUIRED
                    'clientName' => '<string>',
                    'clientSecret' => '<string>', // REQUIRED
                    'exchangeParameters' => ['<string>', ...],
                ],
            ],
            'instanceUrl' => '<string>', // REQUIRED
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'additionalStep' => [
        'oauth' => [
            'authorizationUrl' => '<string>',
        ],
    ],
    'kmsKeyArn' => '<string>',
    'serviceId' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

SendMessage

$result = $client->sendMessage([/* ... */]);
$promise = $client->sendMessageAsync([/* ... */]);

Sends a chat message and streams the response for the specified agent space execution

Parameter Syntax

$result = $client->sendMessage([
    'agentSpaceId' => '<string>', // REQUIRED
    'content' => '<string>', // REQUIRED
    'context' => [
        'currentPage' => '<string>',
        'lastMessage' => '<string>',
        'userActionResponse' => '<string>',
    ],
    'executionId' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'events' => [ // EventParsingIterator
        'contentBlockDelta' => [
            'delta' => [
                'jsonDelta' => [
                    'partialJson' => '<string>',
                ],
                'textDelta' => [
                    'text' => '<string>',
                ],
            ],
            'index' => <integer>,
            'sequenceNumber' => <integer>,
        ],
        'contentBlockStart' => [
            'id' => '<string>',
            'index' => <integer>,
            'parentId' => '<string>',
            'sequenceNumber' => <integer>,
            'type' => '<string>',
        ],
        'contentBlockStop' => [
            'index' => <integer>,
            'last' => true || false,
            'sequenceNumber' => <integer>,
            'text' => '<string>',
            'type' => '<string>',
        ],
        'heartbeat' => [
        ],
        'responseCompleted' => [
            'responseId' => '<string>',
            'sequenceNumber' => <integer>,
            'usage' => [
                'inputTokens' => <integer>,
                'outputTokens' => <integer>,
                'totalTokens' => <integer>,
            ],
        ],
        'responseCreated' => [
            'responseId' => '<string>',
            'sequenceNumber' => <integer>,
        ],
        'responseFailed' => [
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'responseId' => '<string>',
            'sequenceNumber' => <integer>,
        ],
        'responseInProgress' => [
            'responseId' => '<string>',
            'sequenceNumber' => <integer>,
        ],
        'summary' => [
            'content' => '<string>',
            'sequenceNumber' => <integer>,
        ],
    ],
]

Result Details

Using an EventParsingIterator

To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.

foreach($result['events'] as $event) {
    if (isset($event['contentBlockDelta'])) {
        // Handle the 'contentBlockDelta' event.
    } else if (isset($event['contentBlockStart'])) {
        // Handle the 'contentBlockStart' event.
    } else if (isset($event['contentBlockStop'])) {
        // Handle the 'contentBlockStop' event.
    } else if (isset($event['heartbeat'])) {
        // Handle the 'heartbeat' event.
    } else if (isset($event['responseCompleted'])) {
        // Handle the 'responseCompleted' event.
    } else if (isset($event['responseCreated'])) {
        // Handle the 'responseCreated' event.
    } else if (isset($event['responseFailed'])) {
        // Handle the 'responseFailed' event.
    } else if (isset($event['responseInProgress'])) {
        // Handle the 'responseInProgress' event.
    } else if (isset($event['summary'])) {
        // Handle the 'summary' event.
    }
}

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or overwrites tags for the specified AWS DevOps Agent resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the specified AWS DevOps Agent resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdateAgentSpace

$result = $client->updateAgentSpace([/* ... */]);
$promise = $client->updateAgentSpaceAsync([/* ... */]);

Updates the information of an existing AgentSpace.

Parameter Syntax

$result = $client->updateAgentSpace([
    'agentSpaceId' => '<string>', // REQUIRED
    'description' => '<string>',
    'locale' => '<string>',
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentSpace' => [
        'agentSpaceId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'kmsKeyArn' => '<string>',
        'locale' => '<string>',
        'name' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdateAssociation

$result = $client->updateAssociation([/* ... */]);
$promise = $client->updateAssociationAsync([/* ... */]);

Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.

Parameter Syntax

$result = $client->updateAssociation([
    'agentSpaceId' => '<string>', // REQUIRED
    'associationId' => '<string>', // REQUIRED
    'configuration' => [ // REQUIRED
        'aws' => [
            'accountId' => '<string>', // REQUIRED
            'accountType' => 'monitor', // REQUIRED
            'assumableRoleArn' => '<string>', // REQUIRED
        ],
        'azure' => [
            'subscriptionId' => '<string>', // REQUIRED
        ],
        'azuredevops' => [
            'organizationName' => '<string>', // REQUIRED
            'projectId' => '<string>', // REQUIRED
            'projectName' => '<string>', // REQUIRED
        ],
        'dynatrace' => [
            'envId' => '<string>', // REQUIRED
            'resources' => ['<string>', ...],
        ],
        'eventChannel' => [
        ],
        'github' => [
            'instanceIdentifier' => '<string>',
            'owner' => '<string>', // REQUIRED
            'ownerType' => 'organization|user', // REQUIRED
            'repoId' => '<string>', // REQUIRED
            'repoName' => '<string>', // REQUIRED
        ],
        'gitlab' => [
            'instanceIdentifier' => '<string>',
            'projectId' => '<string>', // REQUIRED
            'projectPath' => '<string>', // REQUIRED
        ],
        'mcpservergrafana' => [
            'endpoint' => '<string>', // REQUIRED
            'organizationId' => '<string>',
            'tools' => ['<string>', ...],
        ],
        'mcpservernewrelic' => [
            'accountId' => '<string>', // REQUIRED
            'endpoint' => '<string>', // REQUIRED
        ],
        'msteams' => [
            'teamId' => '<string>', // REQUIRED
            'teamName' => '<string>', // REQUIRED
            'transmissionTarget' => [ // REQUIRED
                'opsOncallTarget' => [
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>', // REQUIRED
                ],
                'opsSRETarget' => [
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>', // REQUIRED
                ],
            ],
        ],
        'pagerduty' => [
            'customerEmail' => '<string>', // REQUIRED
            'services' => ['<string>', ...], // REQUIRED
        ],
        'servicenow' => [
            'authScopes' => ['<string>', ...],
            'instanceId' => '<string>',
        ],
        'slack' => [
            'transmissionTarget' => [ // REQUIRED
                'opsOncallTarget' => [ // REQUIRED
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>',
                ],
                'opsSRETarget' => [
                    'channelId' => '<string>', // REQUIRED
                    'channelName' => '<string>',
                ],
            ],
            'workspaceId' => '<string>', // REQUIRED
            'workspaceName' => '<string>', // REQUIRED
        ],
        'sourceAws' => [
            'accountId' => '<string>', // REQUIRED
            'accountType' => 'source', // REQUIRED
            'assumableRoleArn' => '<string>', // REQUIRED
            'externalId' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'association' => [
        'agentSpaceId' => '<string>',
        'associationId' => '<string>',
        'configuration' => [
            'aws' => [
                'accountId' => '<string>',
                'accountType' => 'monitor',
                'assumableRoleArn' => '<string>',
            ],
            'azure' => [
                'subscriptionId' => '<string>',
            ],
            'azuredevops' => [
                'organizationName' => '<string>',
                'projectId' => '<string>',
                'projectName' => '<string>',
            ],
            'dynatrace' => [
                'envId' => '<string>',
                'resources' => ['<string>', ...],
            ],
            'eventChannel' => [
            ],
            'github' => [
                'instanceIdentifier' => '<string>',
                'owner' => '<string>',
                'ownerType' => 'organization|user',
                'repoId' => '<string>',
                'repoName' => '<string>',
            ],
            'gitlab' => [
                'instanceIdentifier' => '<string>',
                'projectId' => '<string>',
                'projectPath' => '<string>',
            ],
            'mcpservergrafana' => [
                'endpoint' => '<string>',
                'organizationId' => '<string>',
                'tools' => ['<string>', ...],
            ],
            'mcpservernewrelic' => [
                'accountId' => '<string>',
                'endpoint' => '<string>',
            ],
            'msteams' => [
                'teamId' => '<string>',
                'teamName' => '<string>',
                'transmissionTarget' => [
                    'opsOncallTarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                    'opsSRETarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                ],
            ],
            'pagerduty' => [
                'customerEmail' => '<string>',
                'services' => ['<string>', ...],
            ],
            'servicenow' => [
                'authScopes' => ['<string>', ...],
                'instanceId' => '<string>',
            ],
            'slack' => [
                'transmissionTarget' => [
                    'opsOncallTarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                    'opsSRETarget' => [
                        'channelId' => '<string>',
                        'channelName' => '<string>',
                    ],
                ],
                'workspaceId' => '<string>',
                'workspaceName' => '<string>',
            ],
            'sourceAws' => [
                'accountId' => '<string>',
                'accountType' => 'source',
                'assumableRoleArn' => '<string>',
                'externalId' => '<string>',
            ],
        ],
        'createdAt' => <DateTime>,
        'serviceId' => '<string>',
        'status' => 'valid|invalid|pending-confirmation',
        'updatedAt' => <DateTime>,
    ],
    'webhook' => [
        'apiKey' => '<string>',
        'webhookId' => '<string>',
        'webhookSecret' => '<string>',
        'webhookType' => 'hmac|apikey|gitlab|pagerduty',
        'webhookUrl' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdateBacklogTask

$result = $client->updateBacklogTask([/* ... */]);
$promise = $client->updateBacklogTaskAsync([/* ... */]);

Update an existing backlog task.

Parameter Syntax

$result = $client->updateBacklogTask([
    'agentSpaceId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'taskId' => '<string>', // REQUIRED
    'taskStatus' => 'PENDING_TRIAGE|LINKED|PENDING_START|IN_PROGRESS|PENDING_CUSTOMER_APPROVAL|COMPLETED|FAILED|TIMED_OUT|CANCELED',
]);

Parameter Details

Result Syntax

[
    'task' => [
        'agentSpaceId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'executionId' => '<string>',
        'hasLinkedTasks' => true || false,
        'metadata' => [
        ],
        'primaryTaskId' => '<string>',
        'priority' => 'CRITICAL|HIGH|MEDIUM|LOW|MINIMAL',
        'reference' => [
            'associationId' => '<string>',
            'referenceId' => '<string>',
            'referenceUrl' => '<string>',
            'system' => '<string>',
            'title' => '<string>',
        ],
        'status' => 'PENDING_TRIAGE|LINKED|PENDING_START|IN_PROGRESS|PENDING_CUSTOMER_APPROVAL|COMPLETED|FAILED|TIMED_OUT|CANCELED',
        'statusReason' => '<string>',
        'supportMetadata' => [
        ],
        'taskId' => '<string>',
        'taskType' => 'INVESTIGATION|EVALUATION',
        'title' => '<string>',
        'updatedAt' => <DateTime>,
        'version' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdateGoal

$result = $client->updateGoal([/* ... */]);
$promise = $client->updateGoalAsync([/* ... */]);

Update an existing goal

Parameter Syntax

$result = $client->updateGoal([
    'agentSpaceId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'evaluationSchedule' => [
        'state' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'goalId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'goal' => [
        'agentSpaceArn' => '<string>',
        'content' => [
            'description' => '<string>',
            'objectives' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'evaluationSchedule' => [
            'expression' => '<string>',
            'state' => 'ENABLED|DISABLED',
        ],
        'goalId' => '<string>',
        'goalType' => 'CUSTOMER_DEFINED|ONCALL_REPORT',
        'lastEvaluatedAt' => <DateTime>,
        'lastSuccessfulTaskId' => '<string>',
        'lastTaskId' => '<string>',
        'status' => 'ACTIVE|PAUSED|COMPLETE',
        'title' => '<string>',
        'updatedAt' => <DateTime>,
        'version' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdateOperatorAppIdpConfig

$result = $client->updateOperatorAppIdpConfig([/* ... */]);
$promise = $client->updateOperatorAppIdpConfigAsync([/* ... */]);

Update the external Identity Provider configuration for the Operator App

Parameter Syntax

$result = $client->updateOperatorAppIdpConfig([
    'agentSpaceId' => '<string>', // REQUIRED
    'idpClientSecret' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'idp' => [
        'clientId' => '<string>',
        'createdAt' => <DateTime>,
        'issuerUrl' => '<string>',
        'operatorAppRoleArn' => '<string>',
        'provider' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdatePrivateConnectionCertificate

$result = $client->updatePrivateConnectionCertificate([/* ... */]);
$promise = $client->updatePrivateConnectionCertificateAsync([/* ... */]);

Updates the certificate associated with a Private Connection.

Parameter Syntax

$result = $client->updatePrivateConnectionCertificate([
    'certificate' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'certificateExpiryTime' => <DateTime>,
    'hostAddress' => '<string>',
    'name' => '<string>',
    'resourceConfigurationId' => '<string>',
    'resourceGatewayId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'type' => 'SELF_MANAGED|SERVICE_MANAGED',
    'vpcId' => '<string>',
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

UpdateRecommendation

$result = $client->updateRecommendation([/* ... */]);
$promise = $client->updateRecommendationAsync([/* ... */]);

Updates an existing recommendation with new content, status, or metadata

Parameter Syntax

$result = $client->updateRecommendation([
    'additionalContext' => '<string>',
    'agentSpaceId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'recommendationId' => '<string>', // REQUIRED
    'status' => 'PROPOSED|ACCEPTED|REJECTED|CLOSED|COMPLETED|UPDATE_IN_PROGRESS',
]);

Parameter Details

Result Syntax

[
    'recommendation' => [
        'additionalContext' => '<string>',
        'agentSpaceArn' => '<string>',
        'content' => [
            'spec' => '<string>',
            'summary' => '<string>',
        ],
        'createdAt' => <DateTime>,
        'goalId' => '<string>',
        'goalVersion' => <integer>,
        'priority' => 'HIGH|MEDIUM|LOW',
        'recommendationId' => '<string>',
        'status' => 'PROPOSED|ACCEPTED|REJECTED|CLOSED|COMPLETED|UPDATE_IN_PROGRESS',
        'taskId' => '<string>',
        'title' => '<string>',
        'updatedAt' => <DateTime>,
        'version' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.

ValidateAwsAssociations

$result = $client->validateAwsAssociations([/* ... */]);
$promise = $client->validateAwsAssociationsAsync([/* ... */]);

Validates an aws association and set status and returns a 204 No Content response on success.

Parameter Syntax

$result = $client->validateAwsAssociations([
    'agentSpaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ContentSizeExceededException:

This exception is thrown when the content size exceeds the allowed limit.

ServiceQuotaExceededException:

The request would exceed the service quota limit.

ConflictException:

The request conflicts with the current state of the resource.

InternalServerException:

This exception is thrown when an unexpected error occurs in the processing of a request.

AccessDeniedException:

Access to the requested resource is denied due to insufficient permissions.

ResourceNotFoundException:

The requested resource could not be found.

ThrottlingException:

The request was throttled due to too many requests. Please slow down and try again.

InvalidParameterException:

One or more parameters provided in the request are invalid.