AcceptResourceShareInvitation

$result = $client->acceptResourceShareInvitation([/* ... */]);
$promise = $client->acceptResourceShareInvitationAsync([/* ... */]);

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

Parameter Syntax

$result = $client->acceptResourceShareInvitation([
    'clientToken' => '<string>',
    'resourceShareInvitationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'resourceShareInvitation' => [
        'invitationTimestamp' => <DateTime>,
        'receiverAccountId' => '<string>',
        'receiverArn' => '<string>',
        'resourceShareArn' => '<string>',
        'resourceShareAssociations' => [
            [
                'associatedEntity' => '<string>',
                'associationType' => 'PRINCIPAL|RESOURCE',
                'creationTime' => <DateTime>,
                'external' => true || false,
                'lastUpdatedTime' => <DateTime>,
                'resourceShareArn' => '<string>',
                'resourceShareName' => '<string>',
                'status' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
                'statusMessage' => '<string>',
            ],
            // ...
        ],
        'resourceShareInvitationArn' => '<string>',
        'resourceShareName' => '<string>',
        'senderAccountId' => '<string>',
        'status' => 'PENDING|ACCEPTED|REJECTED|EXPIRED',
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ResourceShareInvitationArnNotFoundException:

The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.

ResourceShareInvitationAlreadyAcceptedException:

The operation failed because the specified invitation was already accepted.

ResourceShareInvitationAlreadyRejectedException:

The operation failed because the specified invitation was already rejected.

ResourceShareInvitationExpiredException:

The operation failed because the specified invitation is past its expiration date and time.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

AssociateResourceShare

$result = $client->associateResourceShare([/* ... */]);
$promise = $client->associateResourceShareAsync([/* ... */]);

Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.

Parameter Syntax

$result = $client->associateResourceShare([
    'clientToken' => '<string>',
    'principals' => ['<string>', ...],
    'resourceArns' => ['<string>', ...],
    'resourceShareArn' => '<string>', // REQUIRED
    'sources' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'resourceShareAssociations' => [
        [
            'associatedEntity' => '<string>',
            'associationType' => 'PRINCIPAL|RESOURCE',
            'creationTime' => <DateTime>,
            'external' => true || false,
            'lastUpdatedTime' => <DateTime>,
            'resourceShareArn' => '<string>',
            'resourceShareName' => '<string>',
            'status' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

ResourceShareLimitExceededException:

The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

ThrottlingException:

The operation failed because it exceeded the rate at which you are allowed to perform this operation. Please try again later.

AssociateResourceSharePermission

$result = $client->associateResourceSharePermission([/* ... */]);
$promise = $client->associateResourceSharePermissionAsync([/* ... */]);

Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.

Parameter Syntax

$result = $client->associateResourceSharePermission([
    'clientToken' => '<string>',
    'permissionArn' => '<string>', // REQUIRED
    'permissionVersion' => <integer>,
    'replace' => true || false,
    'resourceShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'returnValue' => true || false,
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

CreatePermission

$result = $client->createPermission([/* ... */]);
$promise = $client->createPermissionAsync([/* ... */]);

Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.

Parameter Syntax

$result = $client->createPermission([
    'clientToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'policyTemplate' => '<string>', // REQUIRED
    'resourceType' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'permission' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'defaultVersion' => true || false,
        'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
        'isResourceTypeDefault' => true || false,
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
        'resourceType' => '<string>',
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

InvalidPolicyException:

The operation failed because a policy you specified isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

PermissionAlreadyExistsException:

The operation failed because a permission with the specified name already exists in the requested Amazon Web Services Region. Choose a different name.

MalformedPolicyTemplateException:

The operation failed because the policy template that you provided isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

PermissionLimitExceededException:

The operation failed because it would exceed the maximum number of permissions you can create in each Amazon Web Services Region. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

CreatePermissionVersion

$result = $client->createPermissionVersion([/* ... */]);
$promise = $client->createPermissionVersionAsync([/* ... */]);

Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.

If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.

Parameter Syntax

$result = $client->createPermissionVersion([
    'clientToken' => '<string>',
    'permissionArn' => '<string>', // REQUIRED
    'policyTemplate' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'permission' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'defaultVersion' => true || false,
        'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
        'isResourceTypeDefault' => true || false,
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'permission' => '<string>',
        'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
        'resourceType' => '<string>',
        'status' => 'ATTACHABLE|UNATTACHABLE|DELETING|DELETED',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

InvalidPolicyException:

The operation failed because a policy you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedPolicyTemplateException:

The operation failed because the policy template that you provided isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

PermissionVersionsLimitExceededException:

The operation failed because it would exceed the limit for the number of versions you can have for a permission. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

CreateResourceShare

$result = $client->createResourceShare([/* ... */]);
$promise = $client->createResourceShareAsync([/* ... */]);

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Parameter Syntax

$result = $client->createResourceShare([
    'allowExternalPrincipals' => true || false,
    'clientToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'permissionArns' => ['<string>', ...],
    'principals' => ['<string>', ...],
    'resourceArns' => ['<string>', ...],
    'sources' => ['<string>', ...],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'resourceShare' => [
        'allowExternalPrincipals' => true || false,
        'creationTime' => <DateTime>,
        'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'owningAccountId' => '<string>',
        'resourceShareArn' => '<string>',
        'status' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED',
        'statusMessage' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ResourceShareLimitExceededException:

The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

TagPolicyViolationException:

The operation failed because the specified tag key is a reserved word and can't be used.

TagLimitExceededException:

The operation failed because it would exceed the limit for tags for your Amazon Web Services account.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

DeletePermission

$result = $client->deletePermission([/* ... */]);
$promise = $client->deletePermissionAsync([/* ... */]);

Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.

Parameter Syntax

$result = $client->deletePermission([
    'clientToken' => '<string>',
    'permissionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'permissionStatus' => 'ATTACHABLE|UNATTACHABLE|DELETING|DELETED',
    'returnValue' => true || false,
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

DeletePermissionVersion

$result = $client->deletePermissionVersion([/* ... */]);
$promise = $client->deletePermissionVersionAsync([/* ... */]);

Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.

If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.

Parameter Syntax

$result = $client->deletePermissionVersion([
    'clientToken' => '<string>',
    'permissionArn' => '<string>', // REQUIRED
    'permissionVersion' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'permissionStatus' => 'ATTACHABLE|UNATTACHABLE|DELETING|DELETED',
    'returnValue' => true || false,
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

DeleteResourceShare

$result = $client->deleteResourceShare([/* ... */]);
$promise = $client->deleteResourceShareAsync([/* ... */]);

Deletes the specified resource share.

Parameter Syntax

$result = $client->deleteResourceShare([
    'clientToken' => '<string>',
    'resourceShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'returnValue' => true || false,
]

Result Details

Errors

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

DisassociateResourceShare

$result = $client->disassociateResourceShare([/* ... */]);
$promise = $client->disassociateResourceShareAsync([/* ... */]);

Removes the specified principals or resources from participating in the specified resource share.

Parameter Syntax

$result = $client->disassociateResourceShare([
    'clientToken' => '<string>',
    'principals' => ['<string>', ...],
    'resourceArns' => ['<string>', ...],
    'resourceShareArn' => '<string>', // REQUIRED
    'sources' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'resourceShareAssociations' => [
        [
            'associatedEntity' => '<string>',
            'associationType' => 'PRINCIPAL|RESOURCE',
            'creationTime' => <DateTime>,
            'external' => true || false,
            'lastUpdatedTime' => <DateTime>,
            'resourceShareArn' => '<string>',
            'resourceShareName' => '<string>',
            'status' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

ResourceShareLimitExceededException:

The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

DisassociateResourceSharePermission

$result = $client->disassociateResourceSharePermission([/* ... */]);
$promise = $client->disassociateResourceSharePermissionAsync([/* ... */]);

Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.

Parameter Syntax

$result = $client->disassociateResourceSharePermission([
    'clientToken' => '<string>',
    'permissionArn' => '<string>', // REQUIRED
    'resourceShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'returnValue' => true || false,
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

EnableSharingWithAwsOrganization

$result = $client->enableSharingWithAwsOrganization([/* ... */]);
$promise = $client->enableSharingWithAwsOrganizationAsync([/* ... */]);

Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called AWSServiceRoleForResourceAccessManager that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.

You must call this operation from an IAM role or user in the organization's management account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'returnValue' => true || false,
]

Result Details

Errors

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

GetPermission

$result = $client->getPermission([/* ... */]);
$promise = $client->getPermissionAsync([/* ... */]);

Retrieves the contents of a managed permission in JSON format.

Parameter Syntax

$result = $client->getPermission([
    'permissionArn' => '<string>', // REQUIRED
    'permissionVersion' => <integer>,
]);

Parameter Details

Result Syntax

[
    'permission' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'defaultVersion' => true || false,
        'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
        'isResourceTypeDefault' => true || false,
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'permission' => '<string>',
        'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
        'resourceType' => '<string>',
        'status' => 'ATTACHABLE|UNATTACHABLE|DELETING|DELETED',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

GetResourcePolicies

$result = $client->getResourcePolicies([/* ... */]);
$promise = $client->getResourcePoliciesAsync([/* ... */]);

Retrieves the resource policies for the specified resources that you own and have shared.

Parameter Syntax

$result = $client->getResourcePolicies([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principal' => '<string>',
    'resourceArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'policies' => ['<string>', ...],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ResourceArnNotFoundException:

The operation failed because the specified Amazon Resource Name (ARN) was not found.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

GetResourceShareAssociations

$result = $client->getResourceShareAssociations([/* ... */]);
$promise = $client->getResourceShareAssociationsAsync([/* ... */]);

Retrieves the lists of resources and principals that associated for resource shares that you own.

Parameter Syntax

$result = $client->getResourceShareAssociations([
    'associationStatus' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
    'associationType' => 'PRINCIPAL|RESOURCE', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principal' => '<string>',
    'resourceArn' => '<string>',
    'resourceShareArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resourceShareAssociations' => [
        [
            'associatedEntity' => '<string>',
            'associationType' => 'PRINCIPAL|RESOURCE',
            'creationTime' => <DateTime>,
            'external' => true || false,
            'lastUpdatedTime' => <DateTime>,
            'resourceShareArn' => '<string>',
            'resourceShareName' => '<string>',
            'status' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
            'statusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

GetResourceShareInvitations

$result = $client->getResourceShareInvitations([/* ... */]);
$promise = $client->getResourceShareInvitationsAsync([/* ... */]);

Retrieves details about invitations that you have received for resource shares.

Parameter Syntax

$result = $client->getResourceShareInvitations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceShareArns' => ['<string>', ...],
    'resourceShareInvitationArns' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resourceShareInvitations' => [
        [
            'invitationTimestamp' => <DateTime>,
            'receiverAccountId' => '<string>',
            'receiverArn' => '<string>',
            'resourceShareArn' => '<string>',
            'resourceShareAssociations' => [
                [
                    'associatedEntity' => '<string>',
                    'associationType' => 'PRINCIPAL|RESOURCE',
                    'creationTime' => <DateTime>,
                    'external' => true || false,
                    'lastUpdatedTime' => <DateTime>,
                    'resourceShareArn' => '<string>',
                    'resourceShareName' => '<string>',
                    'status' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
                    'statusMessage' => '<string>',
                ],
                // ...
            ],
            'resourceShareInvitationArn' => '<string>',
            'resourceShareName' => '<string>',
            'senderAccountId' => '<string>',
            'status' => 'PENDING|ACCEPTED|REJECTED|EXPIRED',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceShareInvitationArnNotFoundException:

The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.

InvalidMaxResultsException:

The operation failed because the specified value for MaxResults isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

GetResourceShares

$result = $client->getResourceShares([/* ... */]);
$promise = $client->getResourceSharesAsync([/* ... */]);

Retrieves details about the resource shares that you own or that are shared with you.

Parameter Syntax

$result = $client->getResourceShares([
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'permissionArn' => '<string>',
    'permissionVersion' => <integer>,
    'resourceOwner' => 'SELF|OTHER-ACCOUNTS', // REQUIRED
    'resourceShareArns' => ['<string>', ...],
    'resourceShareStatus' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED',
    'tagFilters' => [
        [
            'tagKey' => '<string>',
            'tagValues' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resourceShares' => [
        [
            'allowExternalPrincipals' => true || false,
            'creationTime' => <DateTime>,
            'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'owningAccountId' => '<string>',
            'resourceShareArn' => '<string>',
            'status' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED',
            'statusMessage' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

ListPendingInvitationResources

$result = $client->listPendingInvitationResources([/* ... */]);
$promise = $client->listPendingInvitationResourcesAsync([/* ... */]);

Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

Parameter Syntax

$result = $client->listPendingInvitationResources([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceRegionScope' => 'ALL|REGIONAL|GLOBAL',
    'resourceShareInvitationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resources' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'lastUpdatedTime' => <DateTime>,
            'resourceGroupArn' => '<string>',
            'resourceRegionScope' => 'REGIONAL|GLOBAL',
            'resourceShareArn' => '<string>',
            'status' => 'AVAILABLE|ZONAL_RESOURCE_INACCESSIBLE|LIMIT_EXCEEDED|UNAVAILABLE|PENDING',
            'statusMessage' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

ResourceShareInvitationArnNotFoundException:

The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.

MissingRequiredParameterException:

The operation failed because a required input parameter is missing.

ResourceShareInvitationAlreadyRejectedException:

The operation failed because the specified invitation was already rejected.

ResourceShareInvitationExpiredException:

The operation failed because the specified invitation is past its expiration date and time.

ListPermissionAssociations

$result = $client->listPermissionAssociations([/* ... */]);
$promise = $client->listPermissionAssociationsAsync([/* ... */]);

Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.

Parameter Syntax

$result = $client->listPermissionAssociations([
    'associationStatus' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
    'defaultVersion' => true || false,
    'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'permissionArn' => '<string>',
    'permissionVersion' => <integer>,
    'resourceType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'arn' => '<string>',
            'defaultVersion' => true || false,
            'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
            'lastUpdatedTime' => <DateTime>,
            'permissionVersion' => '<string>',
            'resourceShareArn' => '<string>',
            'resourceType' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

ListPermissionVersions

$result = $client->listPermissionVersions([/* ... */]);
$promise = $client->listPermissionVersionsAsync([/* ... */]);

Lists the available versions of the specified RAM permission.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'defaultVersion' => true || false,
            'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
            'isResourceTypeDefault' => true || false,
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
            'resourceType' => '<string>',
            'status' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ListPermissions

$result = $client->listPermissions([/* ... */]);
$promise = $client->listPermissionsAsync([/* ... */]);

Retrieves a list of available RAM permissions that you can use for the supported resource types.

Parameter Syntax

$result = $client->listPermissions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'permissionType' => 'ALL|AWS_MANAGED|CUSTOMER_MANAGED',
    'resourceType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'defaultVersion' => true || false,
            'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
            'isResourceTypeDefault' => true || false,
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
            'resourceType' => '<string>',
            'status' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ListPrincipals

$result = $client->listPrincipals([/* ... */]);
$promise = $client->listPrincipalsAsync([/* ... */]);

Lists the principals that you are sharing resources with or that are sharing resources with you.

Parameter Syntax

$result = $client->listPrincipals([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principals' => ['<string>', ...],
    'resourceArn' => '<string>',
    'resourceOwner' => 'SELF|OTHER-ACCOUNTS', // REQUIRED
    'resourceShareArns' => ['<string>', ...],
    'resourceType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'principals' => [
        [
            'creationTime' => <DateTime>,
            'external' => true || false,
            'id' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'resourceShareArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

ListReplacePermissionAssociationsWork

$result = $client->listReplacePermissionAssociationsWork([/* ... */]);
$promise = $client->listReplacePermissionAssociationsWorkAsync([/* ... */]);

Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.

Parameter Syntax

$result = $client->listReplacePermissionAssociationsWork([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'IN_PROGRESS|COMPLETED|FAILED',
    'workIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'replacePermissionAssociationsWorks' => [
        [
            'creationTime' => <DateTime>,
            'fromPermissionArn' => '<string>',
            'fromPermissionVersion' => '<string>',
            'id' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'status' => 'IN_PROGRESS|COMPLETED|FAILED',
            'statusMessage' => '<string>',
            'toPermissionArn' => '<string>',
            'toPermissionVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ListResourceSharePermissions

$result = $client->listResourceSharePermissions([/* ... */]);
$promise = $client->listResourceSharePermissionsAsync([/* ... */]);

Lists the RAM permissions that are associated with a resource share.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'defaultVersion' => true || false,
            'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
            'isResourceTypeDefault' => true || false,
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
            'resourceType' => '<string>',
            'status' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ListResourceTypes

$result = $client->listResourceTypes([/* ... */]);
$promise = $client->listResourceTypesAsync([/* ... */]);

Lists the resource types that can be shared by RAM.

Parameter Syntax

$result = $client->listResourceTypes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceRegionScope' => 'ALL|REGIONAL|GLOBAL',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resourceTypes' => [
        [
            'resourceRegionScope' => 'REGIONAL|GLOBAL',
            'resourceType' => '<string>',
            'serviceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

ListResources

$result = $client->listResources([/* ... */]);
$promise = $client->listResourcesAsync([/* ... */]);

Lists the resources that you added to a resource share or the resources that are shared with you.

Parameter Syntax

$result = $client->listResources([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'principal' => '<string>',
    'resourceArns' => ['<string>', ...],
    'resourceOwner' => 'SELF|OTHER-ACCOUNTS', // REQUIRED
    'resourceRegionScope' => 'ALL|REGIONAL|GLOBAL',
    'resourceShareArns' => ['<string>', ...],
    'resourceType' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resources' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'lastUpdatedTime' => <DateTime>,
            'resourceGroupArn' => '<string>',
            'resourceRegionScope' => 'REGIONAL|GLOBAL',
            'resourceShareArn' => '<string>',
            'status' => 'AVAILABLE|ZONAL_RESOURCE_INACCESSIBLE|LIMIT_EXCEEDED|UNAVAILABLE|PENDING',
            'statusMessage' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidResourceTypeException:

The operation failed because the specified resource type isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidNextTokenException:

The operation failed because the specified value for NextToken isn't valid. You must specify a value you received in the NextToken response of a previous call to this operation.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

PromotePermissionCreatedFromPolicy

$result = $client->promotePermissionCreatedFromPolicy([/* ... */]);
$promise = $client->promotePermissionCreatedFromPolicyAsync([/* ... */]);

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.

This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.

Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'permission' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'defaultVersion' => true || false,
        'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
        'isResourceTypeDefault' => true || false,
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'permissionType' => 'CUSTOMER_MANAGED|AWS_MANAGED',
        'resourceType' => '<string>',
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => '<string>',
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MissingRequiredParameterException:

The operation failed because a required input parameter is missing.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

PromoteResourceShareCreatedFromPolicy

$result = $client->promoteResourceShareCreatedFromPolicy([/* ... */]);
$promise = $client->promoteResourceShareCreatedFromPolicyAsync([/* ... */]);

When you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.

This operation promotes the resource share to a STANDARD resource share that is fully manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'returnValue' => true || false,
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

ResourceShareLimitExceededException:

The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MissingRequiredParameterException:

The operation failed because a required input parameter is missing.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidStateTransitionException:

The operation failed because the requested operation isn't valid for the resource share in its current state.

UnmatchedPolicyPermissionException:

There isn't an existing managed permission defined in RAM that has the same IAM permissions as the resource-based policy attached to the resource. You should first run PromotePermissionCreatedFromPolicy to create that managed permission.

RejectResourceShareInvitation

$result = $client->rejectResourceShareInvitation([/* ... */]);
$promise = $client->rejectResourceShareInvitationAsync([/* ... */]);

Rejects an invitation to a resource share from another Amazon Web Services account.

Parameter Syntax

$result = $client->rejectResourceShareInvitation([
    'clientToken' => '<string>',
    'resourceShareInvitationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'resourceShareInvitation' => [
        'invitationTimestamp' => <DateTime>,
        'receiverAccountId' => '<string>',
        'receiverArn' => '<string>',
        'resourceShareArn' => '<string>',
        'resourceShareAssociations' => [
            [
                'associatedEntity' => '<string>',
                'associationType' => 'PRINCIPAL|RESOURCE',
                'creationTime' => <DateTime>,
                'external' => true || false,
                'lastUpdatedTime' => <DateTime>,
                'resourceShareArn' => '<string>',
                'resourceShareName' => '<string>',
                'status' => 'ASSOCIATING|ASSOCIATED|FAILED|DISASSOCIATING|DISASSOCIATED',
                'statusMessage' => '<string>',
            ],
            // ...
        ],
        'resourceShareInvitationArn' => '<string>',
        'resourceShareName' => '<string>',
        'senderAccountId' => '<string>',
        'status' => 'PENDING|ACCEPTED|REJECTED|EXPIRED',
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ResourceShareInvitationArnNotFoundException:

The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.

ResourceShareInvitationAlreadyAcceptedException:

The operation failed because the specified invitation was already accepted.

ResourceShareInvitationAlreadyRejectedException:

The operation failed because the specified invitation was already rejected.

ResourceShareInvitationExpiredException:

The operation failed because the specified invitation is past its expiration date and time.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

ReplacePermissionAssociations

$result = $client->replacePermissionAssociations([/* ... */]);
$promise = $client->replacePermissionAssociationsAsync([/* ... */]);

Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.

You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the fromPermissionArn and toPermissionArn parameters.

You can use the optional fromPermissionVersion parameter to update only those resources that use a specified version of the managed permission to the new managed permission.

Parameter Syntax

$result = $client->replacePermissionAssociations([
    'clientToken' => '<string>',
    'fromPermissionArn' => '<string>', // REQUIRED
    'fromPermissionVersion' => <integer>,
    'toPermissionArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'replacePermissionAssociationsWork' => [
        'creationTime' => <DateTime>,
        'fromPermissionArn' => '<string>',
        'fromPermissionVersion' => '<string>',
        'id' => '<string>',
        'lastUpdatedTime' => <DateTime>,
        'status' => 'IN_PROGRESS|COMPLETED|FAILED',
        'statusMessage' => '<string>',
        'toPermissionArn' => '<string>',
        'toPermissionVersion' => '<string>',
    ],
]

Result Details

Errors

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

SetDefaultPermissionVersion

$result = $client->setDefaultPermissionVersion([/* ... */]);
$promise = $client->setDefaultPermissionVersionAsync([/* ... */]);

Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.

Parameter Syntax

$result = $client->setDefaultPermissionVersion([
    'clientToken' => '<string>',
    'permissionArn' => '<string>', // REQUIRED
    'permissionVersion' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'returnValue' => true || false,
]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

TagResource

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

Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.

The tags on a managed permission are the same for all versions of the managed permission.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

TagLimitExceededException:

The operation failed because it would exceed the limit for tags for your Amazon Web Services account.

ResourceArnNotFoundException:

The operation failed because the specified Amazon Resource Name (ARN) was not found.

TagPolicyViolationException:

The operation failed because the specified tag key is a reserved word and can't be used.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UntagResource

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

Removes the specified tag key and value pairs from the specified resource share or managed permission.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.

UpdateResourceShare

$result = $client->updateResourceShare([/* ... */]);
$promise = $client->updateResourceShareAsync([/* ... */]);

Modifies some of the properties of the specified resource share.

Parameter Syntax

$result = $client->updateResourceShare([
    'allowExternalPrincipals' => true || false,
    'clientToken' => '<string>',
    'name' => '<string>',
    'resourceShareArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'resourceShare' => [
        'allowExternalPrincipals' => true || false,
        'creationTime' => <DateTime>,
        'featureSet' => 'CREATED_FROM_POLICY|PROMOTING_TO_STANDARD|STANDARD',
        'lastUpdatedTime' => <DateTime>,
        'name' => '<string>',
        'owningAccountId' => '<string>',
        'resourceShareArn' => '<string>',
        'status' => 'PENDING|ACTIVE|FAILED|DELETING|DELETED',
        'statusMessage' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

IdempotentParameterMismatchException:

The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

MissingRequiredParameterException:

The operation failed because a required input parameter is missing.

UnknownResourceException:

The operation failed because a specified resource couldn't be found.

MalformedArnException:

The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.

InvalidClientTokenException:

The operation failed because the specified client token isn't valid.

InvalidParameterException:

The operation failed because a parameter you specified isn't valid.

OperationNotPermittedException:

The operation failed because the requested operation isn't permitted.

ServerInternalException:

The operation failed because the service could not respond to the request due to an internal problem. Try again later.

ServiceUnavailableException:

The operation failed because the service isn't available. Try again later.