2018/10/15 - AWS Service Catalog - 12 new 2 updated api methods
Changes AWS Service Catalog enables you to reduce administrative maintenance and end-user training while adhering to compliance and security measures. With service actions, you as the administrator can enable end users to perform operational tasks, troubleshoot issues, run approved commands, or request permissions within Service Catalog. Service actions are defined using AWS Systems Manager documents, where you have access to pre-defined actions that implement AWS best practices, such asEC2 stop and reboot, as well as the ability to define custom actions.
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
See also: AWS API Documentation
Request Syntax
client.list_provisioning_artifacts_for_service_action(
ServiceActionId='string',
PageSize=123,
PageToken='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
integer
The maximum number of items to return with this call.
string
The page token for the next set of results. To retrieve the first set of results, use null.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'ProvisioningArtifactViews': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifact': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
}
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactViews (list) --
An array of objects with information about product views and provisioning artifacts.
(dict) --
An object that contains summary information about a product view and a provisioning artifact.
ProductViewSummary (dict) --
Summary information about a product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifact (dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Describes a self-service action.
See also: AWS API Documentation
Request Syntax
client.describe_service_action(
Id='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The self-service action identifier.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'ServiceActionDetail': {
'ServiceActionSummary': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
'Definition': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceActionDetail (dict) --
Detailed information about the self-service action.
ServiceActionSummary (dict) --
Summary information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
Definition (dict) --
A map that defines the self-service action.
(string) --
(string) --
Creates a self-service action.
See also: AWS API Documentation
Request Syntax
client.create_service_action(
Name='string',
DefinitionType='SSM_AUTOMATION',
Definition={
'string': 'string'
},
Description='string',
AcceptLanguage='string',
IdempotencyToken='string'
)
string
[REQUIRED]
The self-service action name.
string
[REQUIRED]
The service action definition type. For example, SSM_AUTOMATION .
dict
[REQUIRED]
The self-service action definition. Can be one of the following:
Name
The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance .
Version
The AWS Systems Manager automation document version. For example, "Version": "1"
AssumeRole
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole" .
To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE" .
Parameters
The list of parameters in JSON format.
For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] .
(string) --
(string) --
string
The self-service action description.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
[REQUIRED]
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ServiceActionDetail': {
'ServiceActionSummary': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
'Definition': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceActionDetail (dict) --
An object containing information about the self-service action.
ServiceActionSummary (dict) --
Summary information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
Definition (dict) --
A map that defines the self-service action.
(string) --
(string) --
Lists all self-service actions.
See also: AWS API Documentation
Request Syntax
client.list_service_actions(
AcceptLanguage='string',
PageSize=123,
PageToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
integer
The maximum number of items to return with this call.
string
The page token for the next set of results. To retrieve the first set of results, use null.
dict
Response Syntax
{
'ServiceActionSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ServiceActionSummaries (list) --
An object containing information about the service actions associated with the provisioning artifact.
(dict) --
Detailed information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Updates a self-service action.
See also: AWS API Documentation
Request Syntax
client.update_service_action(
Id='string',
Name='string',
Definition={
'string': 'string'
},
Description='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The self-service action identifier.
string
The self-service action name.
dict
A map that defines the self-service action.
(string) --
(string) --
string
The self-service action description.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'ServiceActionDetail': {
'ServiceActionSummary': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
'Definition': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceActionDetail (dict) --
Detailed information about the self-service action.
ServiceActionSummary (dict) --
Summary information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
Definition (dict) --
A map that defines the self-service action.
(string) --
(string) --
Executes a self-service action against a provisioned product.
See also: AWS API Documentation
Request Syntax
client.execute_provisioned_product_service_action(
ProvisionedProductId='string',
ServiceActionId='string',
ExecuteToken='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The identifier of the provisioned product.
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
string
[REQUIRED]
An idempotency token that uniquely identifies the execute request.
This field is autopopulated if not provided.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
RecordDetail (dict) --
An object containing detailed information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported value is CFN_STACK .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
Deletes a self-service action.
See also: AWS API Documentation
Request Syntax
client.delete_service_action(
Id='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a batch of self-service actions from the specified provisioning artifact.
See also: AWS API Documentation
Request Syntax
client.batch_disassociate_service_action_from_provisioning_artifact(
ServiceActionAssociations=[
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string'
},
],
AcceptLanguage='string'
)
list
[REQUIRED]
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
(dict) --
A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
ServiceActionId (string) -- [REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
ProductId (string) -- [REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) -- [REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'FailedServiceActionAssociations': [
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'ErrorCode': 'DUPLICATE_RESOURCE'|'INTERNAL_FAILURE'|'LIMIT_EXCEEDED'|'RESOURCE_NOT_FOUND'|'THROTTLING',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedServiceActionAssociations (list) --
An object that contains a list of errors, along with information to help you identify the self-service action.
(dict) --
An object containing information about the error, along with identifying information about the self-service action and its associations.
ServiceActionId (string) --
The self-service action identifier. For example, act-fs7abcd89wxyz .
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
ErrorCode (string) --
The error code. Valid values are listed below.
ErrorMessage (string) --
A text description of the error.
Associates multiple self-service actions with provisioning artifacts.
See also: AWS API Documentation
Request Syntax
client.batch_associate_service_action_with_provisioning_artifact(
ServiceActionAssociations=[
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string'
},
],
AcceptLanguage='string'
)
list
[REQUIRED]
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
(dict) --
A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
ServiceActionId (string) -- [REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
ProductId (string) -- [REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) -- [REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'FailedServiceActionAssociations': [
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'ErrorCode': 'DUPLICATE_RESOURCE'|'INTERNAL_FAILURE'|'LIMIT_EXCEEDED'|'RESOURCE_NOT_FOUND'|'THROTTLING',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedServiceActionAssociations (list) --
An object that contains a list of errors, along with information to help you identify the self-service action.
(dict) --
An object containing information about the error, along with identifying information about the self-service action and its associations.
ServiceActionId (string) --
The self-service action identifier. For example, act-fs7abcd89wxyz .
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
ErrorCode (string) --
The error code. Valid values are listed below.
ErrorMessage (string) --
A text description of the error.
Associates a self-service action with a provisioning artifact.
See also: AWS API Documentation
Request Syntax
client.associate_service_action_with_provisioning_artifact(
ProductId='string',
ProvisioningArtifactId='string',
ServiceActionId='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
string
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates the specified self-service action association from the specified provisioning artifact.
See also: AWS API Documentation
Request Syntax
client.disassociate_service_action_from_provisioning_artifact(
ProductId='string',
ProvisioningArtifactId='string',
ServiceActionId='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
string
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
See also: AWS API Documentation
Request Syntax
client.list_service_actions_for_provisioning_artifact(
ProductId='string',
ProvisioningArtifactId='string',
PageSize=123,
PageToken='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
string
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
integer
The maximum number of items to return with this call.
string
The page token for the next set of results. To retrieve the first set of results, use null.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'ServiceActionSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ServiceActionSummaries (list) --
An object containing information about the self-service actions associated with the provisioning artifact.
(dict) --
Detailed information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'ProvisionedProductDetail': {'ProductId': 'string',
'ProvisioningArtifactId': 'string'}}
Gets information about the specified provisioned product.
See also: AWS API Documentation
Request Syntax
client.describe_provisioned_product(
AcceptLanguage='string',
Id='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
[REQUIRED]
The provisioned product identifier.
dict
Response Syntax
{
'ProvisionedProductDetail': {
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string'
},
'CloudWatchDashboards': [
{
'Name': 'string'
},
]
}
Response Structure
(dict) --
ProvisionedProductDetail (dict) --
Information about the provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported value is CFN_STACK .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state, operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
StatusMessage (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
CloudWatchDashboards (list) --
Any CloudWatch dashboards that were created when provisioning the product.
(dict) --
Information about a CloudWatch dashboard.
Name (string) --
The name of the CloudWatch dashboard.
{'ProvisionedProducts': {'ProductId': 'string',
'ProvisioningArtifactId': 'string'}}
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts .
See also: AWS API Documentation
Request Syntax
client.scan_provisioned_products(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
PageSize=123,
PageToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
The access level to use to obtain results. The default is User .
Key (string) --
The access level.
Account - Filter results based on the account.
Role - Filter results based on the federated role of the specified user.
User - Filter results based on the specified user.
Value (string) --
The user to which the access level applies. The only supported value is Self .
integer
The maximum number of items to return with this call.
string
The page token for the next set of results. To retrieve the first set of results, use null.
dict
Response Syntax
{
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProducts (list) --
Information about the provisioned products.
(dict) --
Information about a provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported value is CFN_STACK .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state, operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
StatusMessage (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.