• 沒有找到結果。

AWS Managed Services

N/A
N/A
Protected

Academic year: 2022

Share "AWS Managed Services"

Copied!
111
0
0

加載中.... (立即查看全文)

全文

(1)

AWS Managed Services

Change Management API Reference

API Version 2020-05-21

(2)

AWS Managed Services: Change Management API Reference

Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

(3)

Table of Contents

Welcome ... 1

Actions ... 2

ApproveRfc ... 3

Request Syntax ... 3

Request Parameters ... 3

Response Elements ... 3

Errors ... 3

See Also ... 4

CancelRfc ... 5

Request Syntax ... 5

Request Parameters ... 5

Response Elements ... 5

Errors ... 5

See Also ... 6

CreateRfc ... 7

Request Syntax ... 7

Request Parameters ... 7

Response Syntax ... 9

Response Elements ... 9

Errors ... 9

See Also ... 10

CreateRfcAttachment ... 11

Request Syntax ... 11

Request Parameters ... 11

Response Syntax ... 11

Response Elements ... 11

Errors ... 12

See Also ... 12

CreateRfcCorrespondence ... 14

Request Syntax ... 14

Request Parameters ... 14

Response Syntax ... 14

Response Elements ... 14

Errors ... 15

See Also ... 15

GetChangeTypeVersion ... 16

Request Syntax ... 16

Request Parameters ... 16

Response Syntax ... 17

Response Elements ... 17

Errors ... 17

See Also ... 18

GetRfc ... 19

Request Syntax ... 19

Request Parameters ... 19

Response Syntax ... 19

Response Elements ... 20

Errors ... 20

See Also ... 21

GetRfcAttachment ... 22

Request Syntax ... 22

Request Parameters ... 22

Response Syntax ... 22

Response Elements ... 22

(4)

Errors ... 23

See Also ... 23

ListChangeTypeCategories ... 24

Request Syntax ... 24

Request Parameters ... 24

Response Syntax ... 24

Response Elements ... 24

Errors ... 25

See Also ... 25

ListChangeTypeClassificationSummaries ... 26

Request Syntax ... 26

Request Parameters ... 26

Response Syntax ... 27

Response Elements ... 27

Errors ... 27

See Also ... 28

ListChangeTypeItems ... 29

Request Syntax ... 29

Request Parameters ... 29

Response Syntax ... 30

Response Elements ... 30

Errors ... 30

See Also ... 30

ListChangeTypeOperations ... 32

Request Syntax ... 32

Request Parameters ... 32

Response Syntax ... 33

Response Elements ... 33

Errors ... 33

See Also ... 34

ListChangeTypeSubcategories ... 35

Request Syntax ... 35

Request Parameters ... 35

Response Syntax ... 35

Response Elements ... 36

Errors ... 36

See Also ... 36

ListChangeTypeVersionSummaries ... 37

Request Syntax ... 37

Request Parameters ... 37

Response Syntax ... 37

Response Elements ... 38

Errors ... 38

See Also ... 38

ListRestrictedExecutionTimes ... 40

Request Syntax ... 40

Request Parameters ... 40

Response Syntax ... 40

Response Elements ... 40

(5)

See Also ... 44

ListRfcCorrespondences ... 45

Request Syntax ... 45

Request Parameters ... 45

Response Syntax ... 46

Response Elements ... 46

Errors ... 46

See Also ... 47

ListRfcSummaries ... 48

Request Syntax ... 48

Request Parameters ... 48

Response Syntax ... 51

Response Elements ... 52

Errors ... 52

Examples ... 52

See Also ... 54

RejectRfc ... 55

Request Syntax ... 55

Request Parameters ... 55

Response Elements ... 55

Errors ... 55

See Also ... 56

SubmitRfc ... 57

Request Syntax ... 57

Request Parameters ... 57

Response Elements ... 57

Errors ... 57

See Also ... 58

UpdateRestrictedExecutionTimes ... 59

Request Syntax ... 59

Request Parameters ... 59

Response Elements ... 59

Errors ... 59

See Also ... 59

UpdateRfc ... 61

Request Syntax ... 61

Request Parameters ... 61

Response Elements ... 63

Errors ... 63

See Also ... 63

Data Types ... 64

AutomationStatus ... 65

Contents ... 65

See Also ... 65

ChangeTypeAccessLevel ... 66

Contents ... 66

See Also ... 66

ChangeTypeApprovalCondition ... 67

Contents ... 67

See Also ... 67

ChangeTypeApprovalRequirement ... 68

Contents ... 68

See Also ... 68

ChangeTypeAutomationStatus ... 69

Contents ... 69

See Also ... 69

ChangeTypeClassificationSummary ... 70

(6)

Contents ... 70

See Also ... 70

ChangeTypeOperationSummary ... 71

Contents ... 71

See Also ... 71

ChangeTypeVersion ... 72

Contents ... 72

See Also ... 73

ChangeTypeVersionSummary ... 74

Contents ... 74

See Also ... 75

Email ... 76

Contents ... 76

See Also ... 76

Filter ... 77

Contents ... 77

See Also ... 77

LinkedAttachment ... 78

Contents ... 78

See Also ... 78

RestrictedExecutionTime ... 79

Contents ... 79

See Also ... 79

Rfc ... 80

Contents ... 80

See Also ... 83

RfcActionState ... 84

Contents ... 84

See Also ... 84

RfcApprovalState ... 85

Contents ... 85

See Also ... 85

RfcApprovalStatus ... 86

Contents ... 86

See Also ... 86

RfcAttachment ... 87

Contents ... 87

See Also ... 88

RfcAttachmentSummary ... 89

Contents ... 89

See Also ... 90

RfcCorrespondence ... 91

Contents ... 91

See Also ... 92

RfcNotification ... 93

Contents ... 93

See Also ... 93

RfcRestrictedExecutionTimesOverride ... 94

Contents ... 94

(7)

Contents ... 99

See Also ... 99

UserType ... 100

Contents ... 100

See Also ... 100

Common Parameters ... 101

Common Errors ... 103

(8)

Welcome

The change management API provides operations to create and manage requests for change (RFCs). RFCs can be created, updated, submitted, approved (or rejected), and canceled.

Creating a Request for Change

To create a request for change, begin by calling CreateRfc (p. 7). After creating the basic RFC and before submitting it, you can add or update information (Description, ExpectedOutcome, ImplementationPlan, RollbackPlan, and WorstCaseScenario) by using the UpdateRfc operation (UpdateRfc (p. 61)).

When all necessary information has been added, use SubmitRfc (p. 57) to activate the RFC.

NoteAlthough only the change type (ChangeTypeId and ChangeTypeVersion) and Title are required to initially create an RFC, you must provide values for these fields (either in the original CreateRfc (p. 7) call or by using the corresponding UpdateRfc (UpdateRfc (p. 61)

operation) before calling SubmitRfc (p. 57):

• RequestedStartTime (CreateRfc (p. 7) and RequestedEndTime, if you want to

schedule the RFC. If scheduling is unimportant, leave off these values and execution begins as soon as the RFC is approved. This is part of a feature known as ASAP, or un-scheduled RFC.

• ExecutionParameters that comply with the JSON ExecutionInputSchema of the change type that is associated with the RFC (CreateRfc (p. 7) or UpdateRfc (p. 61))

For more information and examples, see Change Management in the AWS Managed Services User Guide.

Getting information about an RFC

The GetRfc (p. 19) operation shows most of the information about an RFC, including the approval status and execution status.

If an RFC is rejected or canceled, the reason for the action appears in the RfcReason.

Service Endpoint

The HTTP endpoint for the Change Management API is:

• https://amscm.us-east-1.amazonaws.com

This document was last published on March 6, 2022.

(9)

Actions

The following actions are supported:

• ApproveRfc (p. 3)

• CancelRfc (p. 5)

• CreateRfc (p. 7)

• CreateRfcAttachment (p. 11)

• CreateRfcCorrespondence (p. 14)

• GetChangeTypeVersion (p. 16)

• GetRfc (p. 19)

• GetRfcAttachment (p. 22)

• ListChangeTypeCategories (p. 24)

• ListChangeTypeClassificationSummaries (p. 26)

• ListChangeTypeItems (p. 29)

• ListChangeTypeOperations (p. 32)

• ListChangeTypeSubcategories (p. 35)

• ListChangeTypeVersionSummaries (p. 37)

• ListRestrictedExecutionTimes (p. 40)

• ListRfcAttachmentSummaries (p. 42)

• ListRfcCorrespondences (p. 45)

• ListRfcSummaries (p. 48)

• RejectRfc (p. 55)

• SubmitRfc (p. 57)

• UpdateRestrictedExecutionTimes (p. 59)

• UpdateRfc (p. 61)

(10)

ApproveRfc

ApproveRfc

Marks the specified RFC as approved.

An RFC with a CT of "Execution mode: Manual" requires approval; rarely it requires customer

response, either approval or rejection. If your response is explicitly required, the Approval Status:

CustomerApproval Pending RFC status is in the RFC execution output, but you receive no other notice. You must explicitly reject or approve the RFC by running this operation or the RejectRfc operation.

Request Syntax

{ "RfcId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

RfcId (p. 3)

The unique ID (UUID) of the RFC to approve.

Type: String Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

(11)

See Also

ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(12)

CancelRfc

CancelRfc

Cancels the specified RFC.

Request Syntax

{ "Reason": "string", "RfcId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Reason (p. 5)

The reason for the cancellation.

If an RFC is rejected or canceled, the reason for the action appears in the RfcReason.

Type: String Required: Yes RfcId (p. 5)

The unique ID (UUID) of the RFC to cancel.

Type: String Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

(13)

See Also

InvalidRfcStateException

The RFC is not in a state that allows the requested operation. Actual status code: 409 HTTP Status Code: 400

ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(14)

CreateRfc

CreateRfc

Creates a new RFC.

To create a request for change, begin by calling CreateRfc (p. 7). After creating the basic RFC and before submitting it, you can add or update information (Description, ExpectedOutcome, ImplementationPlan, RollbackPlan, and WorstCaseScenario) by using the UpdateRfc operation (UpdateRfc (p. 61)).

When all necessary information has been added, use SubmitRfc (p. 57) to activate the RFC.

NoteAlthough only the change type (ChangeTypeId and ChangeTypeVersion) and Title are required to initially create an RFC, you must provide values for these fields (either in the original CreateRfc (p. 7) call or by using the corresponding UpdateRfc (UpdateRfc (p. 61)

operation) before calling SubmitRfc (p. 57):

• RequestedStartTime (CreateRfc (p. 7) and RequestedEndTime, if you want to

schedule the RFC. If scheduling is unimportant, leave off these values and execution begins as soon as the RFC is approved. This is part of a feature known as ASAP, or un-scheduled RFC.

• ExecutionParameters that comply with the JSON ExecutionInputSchema of the change type that is associated with the RFC (CreateRfc (p. 7) or UpdateRfc (p. 61))

For more information and examples, see Change Management in the AWS Managed Services User Guide.

Request Syntax

{ "ChangeTypeId": "string", "ChangeTypeVersion": "string", "Description": "string",

"ExecutionParameters": "string", "ExpectedOutcome": "string", "ImplementationPlan": "string", "Notification": {

"Email": {

"EmailRecipients": [ "string" ] }

},

"RequestedEndTime": "string", "RequestedStartTime": "string", "RollbackPlan": "string", "Title": "string",

"WorstCaseScenario": "string"

}

Request Parameters

(15)

Request Parameters

Type: String Required: Yes

ChangeTypeVersion (p. 7)

The version of the change type for the request; for example, "1.0".

Type: String Required: Yes Description (p. 7)

The description of the RFC.

Type: String Required: No

ExecutionParameters (p. 7)

The parameters that are required to execute the RFC, submitted in JSON format.

Type: String Required: No ExpectedOutcome (p. 7)

A description of the effects of the change.

Type: String Required: No

ImplementationPlan (p. 7)

The actions or steps required to implement the change (for change types that are not automated).

Type: String Required: No Notification (p. 7)

Create a notification for an existing RFC.

Type: RfcNotification (p. 93) object Required: No

RequestedEndTime (p. 7)

The end of the change window, expressed in ISO 8601 format. The default format is the basic format (YYYYMMDDThhmmssZ). For example, 2017/02/27 at 2:30 PM would be 20170227T143000Z. An RFC does not fail if the requested end time is exceeded.

Type: String Required: No

RequestedStartTime (p. 7)

The start of the change window, expressed in ISO 8601 format. The default format is the basic format (YYYYMMDDThhmmssZ). For example, 2017/02/27 at 2:10 PM would be 20170227T141000Z.

For best results, set the requested start time to at least 20 minutes past the time that you expect

(16)

Response Syntax

to submit the RFC. Alternatively, you can use the ASAP option, which causes the RFC to be executed as soon as it is approved, to use this option, do not specify any start time. If the RFC does not pass syntax or other checks before the requested start time (if one is set), the RFC is canceled.

Type: String Required: No RollbackPlan (p. 7)

The actions or steps required to undo the change.

Type: String Required: No Title (p. 7)

A name for the RFC; this is displayed as the subject of the RFC in the AMS console.

Type: String Required: Yes WorstCaseScenario (p. 7)

A description of the most unfavorable outcome of the change.

Type: String Required: No

Response Syntax

{ "RfcId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RfcId (p. 9)

The unique ID (UUID) of the RFC that was created.

Type: String

Errors

(17)

See Also

InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(18)

CreateRfcAttachment

CreateRfcAttachment

Create an attachment for an existing RFC.

Request Syntax

{

"Content": blob, "FileName": "string", "RfcId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Content (p. 11)

The content of the RFC attachment, which is binary data.

Type: Base64-encoded binary data object Required: Yes

FileName (p. 11)

The file name of the RFC attachment.

Type: String Required: Yes RfcId (p. 11)

The RFC identifier for an RFC attachment request.

Type: String Required: Yes

Response Syntax

{

"AttachmentId": "string",

(19)

Errors

AttachmentId (p. 11)

The attachment identifier in an RFC attachment response.

Type: String RfcId (p. 11)

The RFC identifier in an RFC attachment request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400 InvalidRfcStateException

The RFC is not in a state that allows the requested operation. Actual status code: 409 HTTP Status Code: 400

ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

ServiceQuotaExceededException

You have exceeded your service quotas.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(20)

See Also

(21)

CreateRfcCorrespondence

CreateRfcCorrespondence

Create the correspondence for an RFC.

Request Syntax

{

"AttachmentIds": [ "string" ], "Content": "string",

"RfcId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

AttachmentIds (p. 14)

The attachment identifiers for an RFC correspondence request.

Type: Array of strings Required: No

Content (p. 14)

The content for an RFC correspondence request.

Type: String Required: Yes RfcId (p. 14)

The RFC identifier for an RFC correspondence request.

Type: String Required: Yes

Response Syntax

{

"CorrespondenceId": "string", "RfcId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

(22)

Errors

CorrespondenceId (p. 14)

The correspondence identifier in an RFC correspondence response.

Type: String RfcId (p. 14)

The RFC identifier in an RFC correspondence response.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400 InvalidRfcStateException

The RFC is not in a state that allows the requested operation. Actual status code: 409 HTTP Status Code: 400

ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

(23)

GetChangeTypeVersion

GetChangeTypeVersion

Returns information about the specified change type; optionally, you can specify a change type version identifier. By default, the most recent version of the change type is returned.

The information returned includes:

• Execution approval requirements (ApprovalCondition)

• Whether execution of the change is automated or manual (AutomationStatus)

• Change type deprecation information (DeprecationMessage and DeprecationTime)

• An estimate of the time required for execution of the change (ExpectedExecutionDurationInMinutes)

• The parameters that can be specified for the change (ExecutionInputSchema)

For more information and examples, see Understanding Change Types in the AWS Managed Services User Guide.

Request Syntax

{ "ChangeTypeId": "string", "Locale": "string", "Version": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

ChangeTypeId (p. 16)

The unique ID of the change type, in the form ct-2ty5seo8rxfsc.

Type: String Required: Yes Locale (p. 16)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No Version (p. 16)

The version identifier of the change type to return.

NoteIf you use the AWS CLI and want to specify a change type version in the request, you must use extra double hyphens (--) to cause the CLI to interpret the --version parameter correctly (and not interpret it as a base AWS CLI option). Any base AWS CLI options and parameters (not specific to the AWS Managed Services API), such as --output or -- profile, must appear before the double hyphen. The simplest way to do this is by putting

(24)

Response Syntax

the double hyphens immediately before the get-change-type-version command. For example: aws amscm --output text -- get-change-type-version --version 1.0This special treatment applies only if you specify the parameter on the command line; no special treatment is necessary if you provide parameters in JSON format.

Type: String Required: No

Response Syntax

{

"ChangeTypeVersion": { "AccessLevel": { "Id": "string", "Name": "string"

},

"ApprovalCondition": { "AwsApproval": { "Id": "string", "Name": "string"

},

"CustomerApproval": { "Id": "string", "Name": "string"

} },

"AutomationStatus": { "Id": "string", "Name": "string"

},

"ChangeTypeId": "string", "CreatedTime": "string",

"DeprecationMessage": "string", "DeprecationTime": "string", "ExecutionInputSchema": "string", "ExecutionOutputSchema": "string",

"ExpectedExecutionDurationInMinutes": number, "Name": "string",

"Version": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeTypeVersion (p. 17)

(25)

See Also

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400 ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(26)

GetRfc

GetRfc

Returns information about the specified RFC ID.

Request Syntax

{ "Locale": "string", "RfcId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Locale (p. 19)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No RfcId (p. 19)

The unique ID (UUID) of the RFC Type: String

Required: Yes

Response Syntax

{ "Rfc": {

"ActionState": { "Id": "string", "Name": "string"

},

"ActualExecutionTimeRange": { "EndTime": "string",

"StartTime": "string"

},

(27)

Response Elements

"AutomationStatus": { "Id": "string", "Name": "string"

},

"ChangeTypeId": "string", "ChangeTypeVersion": "string", "CreatedBy": "string",

"CreatedTime": "string", "Description": "string", "ExecutionOutput": "string", "ExecutionParameters": "string", "ExpectedOutcome": "string", "ImplementationPlan": "string", "LastCorrespondenceTime": "string", "LastModifiedBy": "string",

"LastModifiedTime": "string", "LastSubmittedTime": "string", "Notification": {

"Email": {

"EmailRecipients": [ "string" ] }

},

"RequestedExecutionTimeRange": { "EndTime": "string",

"StartTime": "string"

},

"RestrictedExecutionTimesOverride": { "Id": "string",

"Name": "string"

},

"RfcId": "string",

"RollbackPlan": "string", "Status": {

"Id": "string", "Name": "string"

},

"StatusReason": "string", "Title": "string",

"WorstCaseScenario": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Rfc (p. 19)

Information about the RFC.

Type: Rfc (p. 80) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

(28)

See Also

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400 ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(29)

GetRfcAttachment

GetRfcAttachment

Retrieve the attachment from an RFC.

Request Syntax

{ "AttachmentId": "string", "RfcId": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

AttachmentId (p. 22)

The attachment identifier in an RFC attachment GET request.

Type: String Required: Yes RfcId (p. 22)

The RFC identifier in an RFC attachment GET request.

Type: String Required: Yes

Response Syntax

{ "RfcAttachment": {

"AttachmentId": "string", "Content": blob,

"ContentLengthInBytes": number, "ContentType": "string",

"CreatedBy": "string", "CreatedTime": "string", "FileName": "string", "RfcId": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

(30)

Errors

RfcAttachment (p. 22)

The RFC attachment in an RFC attachment GET response.

Type: RfcAttachment (p. 87) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400 ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(31)

ListChangeTypeCategories

ListChangeTypeCategories

Returns the available change type category values.

Request Syntax

{ "Locale": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Locale (p. 24)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 24)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 24)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String Required: No

Response Syntax

{ "ChangeTypeCategories": [ "string" ], "NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

(32)

Errors

The following data is returned in JSON format by the service.

ChangeTypeCategories (p. 24)

The available change type category values.

Type: Array of strings NextToken (p. 24)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(33)

ListChangeTypeClassificationSummaries

ListChangeTypeClassificationSummaries

Returns the classifications (category, subcategory, item, and operation) for all change types that meet the specified (optional) filter criteria.

Request Syntax

{ "Filters": [ {

"Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] }

],

"Locale": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Filters (p. 26)

Attribute/value pairs to narrow the results returned. Filter criteria are combined in a logical OR operation, and values that contain spaces are also combined in an OR operation. For example, a Value of "read-only access" matches all values that contain "read-only" OR "access". Valid filter attributes: Category, Subcategory, Item, Operation, ChangeTypeId.

For more information and examples, see Finding Change Types in the AWS Managed Services User Guide.

Type: Array of Filter (p. 77) objects Required: No

Locale (p. 26)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 26)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No

(34)

Response Syntax

NextToken (p. 26)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String Required: No

Response Syntax

{ "ChangeTypeClassificationSummaries": [ {

"Category": "string", "ChangeTypeId": "string", "Item": "string",

"Operation": "string", "Subcategory": "string"

} ],

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeTypeClassificationSummaries (p. 27)

The change type classifications that satisfy the filter criteria.

Type: Array of ChangeTypeClassificationSummary (p. 70) objects NextToken (p. 27)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Errors

(35)

See Also

InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(36)

ListChangeTypeItems

ListChangeTypeItems

Returns the available change type item values for the specified category and subcategory values.

Request Syntax

{ "Category": "string", "Locale": "string", "MaxResults": number, "NextToken": "string", "Subcategory": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Category (p. 29)

The change type category value to return the item values for.

Type: String Required: Yes Locale (p. 29)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 29)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 29)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue

(37)

Response Syntax

Type: String Required: Yes

Response Syntax

{ "ChangeTypeItems": [ "string" ], "NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeTypeItems (p. 30)

The change type item values for the specified category and subcategory values.

Type: Array of strings NextToken (p. 30)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

(38)

See Also

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(39)

ListChangeTypeOperations

ListChangeTypeOperations

Returns the available change type operation values for the specified category and subcategory values.

Request Syntax

{ "Category": "string", "Item": "string", "Locale": "string", "MaxResults": number, "NextToken": "string", "Subcategory": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Category (p. 32)

The change type category value to return the operation values for.

Type: String Required: Yes Item (p. 32)

The change type item values to return the operation values for.

Type: String Required: Yes Locale (p. 32)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 32)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 32)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

(40)

Response Syntax

Type: String Required: No Subcategory (p. 32)

The change type subcategory values to return the operation values for.

Type: String Required: Yes

Response Syntax

{

"ChangeTypeOperationSummaries": [ {

"ChangeTypeId": "string", "Operation": "string"

} ],

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeTypeOperationSummaries (p. 33)

The change type operation values for the specified category, subcategory, and item values.

Type: Array of ChangeTypeOperationSummary (p. 71) objects NextToken (p. 33)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

(41)

See Also

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(42)

ListChangeTypeSubcategories

ListChangeTypeSubcategories

Returns the available change type subcategory values for the specified category value.

Request Syntax

{ "Category": "string", "Locale": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Category (p. 35)

The change type category value to return the subcategory values for.

Type: String Required: Yes Locale (p. 35)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 35)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 35)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

(43)

Response Elements

"ChangeTypeSubcategories": [ "string" ], "NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeTypeSubcategories (p. 35)

The change type subcategory values for the specified category value.

Type: Array of strings NextToken (p. 35)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(44)

ListChangeTypeVersionSummaries

ListChangeTypeVersionSummaries

Returns version information (versions and deprecation times) for the specified change type.

Request Syntax

{

"Filters": [ {

"Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] }

],

"MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Filters (p. 37)

The only valid filter attribute is ChangeTypeId, and a value is required.

Type: Array of Filter (p. 77) objects Required: No

MaxResults (p. 37)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 37)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

(45)

Response Elements

"AccessLevel": { "Id": "string", "Name": "string"

},

"AutomationStatus": { "Id": "string", "Name": "string"

},

"ChangeTypeId": "string", "CreatedTime": "string", "DeprecationTime": "string", "Description": "string", "Name": "string", "Version": "string"

} ],

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeTypeVersionSummaries (p. 37)

The version information (versions and deprecation times) for the specified change type.

Type: Array of ChangeTypeVersionSummary (p. 74) objects NextToken (p. 37)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

(46)

See Also

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(47)

ListRestrictedExecutionTimes

ListRestrictedExecutionTimes

Returns the time ranges during which change execution is restricted.

Request Syntax

{ "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

MaxResults (p. 40)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 40)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String Required: No

Response Syntax

{ "NextToken": "string",

"RestrictedExecutionTimes": [ {

"TimeRange": {

"EndTime": "string", "StartTime": "string"

} } ]}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

(48)

Errors

The following data is returned in JSON format by the service.

NextToken (p. 40)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

RestrictedExecutionTimes (p. 40)

The time ranges during which change execution is restricted.

Type: Array of RestrictedExecutionTime (p. 79) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500 InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(49)

ListRfcAttachmentSummaries

ListRfcAttachmentSummaries

The Request for Change (RFCs) attachments.

Request Syntax

{

"Filters": [ {

"Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] }

],

"Locale": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Filters (p. 42)

The only valid filter attribute is RfcId, and a value is required.

Type: Array of Filter (p. 77) objects Required: No

Locale (p. 42)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 42)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 42)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

(50)

Response Syntax

Required: No

Response Syntax

{

"NextToken": "string", "RfcAttachmentSummaries": [ {

"AttachmentId": "string", "ContentLengthInBytes": number, "ContentType": "string",

"CreatedBy": "string", "CreatedTime": "string", "FileName": "string", "RfcId": "string"

} ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 43)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

RfcAttachmentSummaries (p. 43)

List a summary of the existing attachments of an RFC.

Type: Array of RfcAttachmentSummary (p. 89) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

(51)

See Also

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(52)

ListRfcCorrespondences

ListRfcCorrespondences

List the existing correspondences of an RFC.

Request Syntax

{

"Filters": [ {

"Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] }

],

"Locale": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Filters (p. 45)

The only valid filter attribute is RfcId, and a value is required.

Type: Array of Filter (p. 77) objects Required: No

Locale (p. 45)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 45)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer

(53)

Response Syntax

Required: No

Response Syntax

{

"NextToken": "string", "RfcCorrespondences": [ {

"Content": "string",

"CorrespondenceId": "string", "CreatedBy": "string", "CreatedTime": "string", "LinkedAttachments": [ {

"AttachmentId": "string", "CreatedBy": "string", "CreatedTime": "string", "FileName": "string"

} ],

"RfcId": "string", "UserType": { "Id": "string", "Name": "string"

} } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 46)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

RfcCorrespondences (p. 46)

The list of correspondences for an existing RFC.

Type: Array of RfcCorrespondence (p. 91) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 103).

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500

(54)

See Also

InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400 ResourceNotFoundException

A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(55)

ListRfcSummaries

ListRfcSummaries

Returns summaries of Request for Change (RFCs) that meet the specified criteria.

Request Syntax

{

"Filters": [ {

"Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] }

],

"Locale": "string", "MaxResults": number, "NextToken": "string", "RequestedEndTimeRange": { "EndTime": "string", "StartTime": "string"

},

"RequestedStartTimeRange": { "EndTime": "string", "StartTime": "string"

}}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 101).

The request accepts the following data in JSON format.

Filters (p. 48)

You can Filter results based on an Attribute and Value combined in a logical AND operation, or based on an Attribute, a Condition, and Values.

The following are the valid filter attributes:

ActualEndTime

• Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”).

• Valid Conditions: Before, After, Between

• Default Condition: None

• Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value.

ActualStartTime

• Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”).

• Valid Conditions: Before, After, Between

• Default Condition: None

• Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value.

(56)

Request Parameters

AutomationStatusId

• Valid Values: Manual, Automated

• Valid Conditions: Equals

• Default Condition: Equals

• Notes: There are only two automation statuses.

ChangeTypeId

• Valid Values: Any valid change type ID; for example, ct-123h45t6uz7jl.

• Valid Conditions: Equals

• Default Condition: Equals

• Notes: Finding a Change Type or CISO in the AMS User Guide.

ChangeTypeVersion

• Valid Values: Any valid change type ID; for example, 1.0.

• Valid Conditions: Equals

• Default Condition: Equals

• Notes: Finding a Change Type or CISO in the AMS User Guide.

CreatedBy

• Valid Values: Any string (maximum allowed length is 2048 characters).

• Valid Conditions: Contains

• Default Condition: Contains

• Notes: The CreatedBy field of the RFC contains the ARN of the user who created it.

CreatedTime

• Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”).

• Valid Conditions: Before, After, Between

• Default Condition: None

• Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value.

LastModifiedTime

• Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”).

• Valid Conditions: Before, After, Between

• Default Condition: None

• Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value.

LastSubmittedTime

• Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”).

• Valid Conditions: Before, After, Between

• Default Condition: None

(57)

Request Parameters

• Notes:The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value.

RequestedStartTime

• Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”).

• Valid Conditions: Before, After, Between

• Default Condition: None

• Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value.

RfcStatusId

• Valid Values: Canceled, Editing, Failure, InProgress, PendingApproval, Rejected, Scheduled, Success

• Valid Conditions: Equals

• Default Condition: Equals

• Notes: Refresh the RFC list in the AMS console or run GetRfc (p. 19).

Title

• Valid Values: Any valid RFC title.

• Valid Conditions: Contains

• Default Condition: Contains

• Notes: Regular expressions in each individual field are not supported. Case insensitive search.

For more information about the filter attributes and examples, see Finding RFCs in the AMS User Guide.

Type: Array of Filter (p. 77) objects Required: No

Locale (p. 48)

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String Required: No MaxResults (p. 48)

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer Required: No NextToken (p. 48)

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String Required: No

參考文獻

相關文件

(3)In principle, one of the documents from either of the preceding paragraphs must be submitted, but if the performance is to take place in the next 30 days and the venue is not

< Notes for Schools: schools are advised to fill in the estimated minimum quantity and maximum quantity (i.e. the range of the quantity) of the items under Estimated Quantity

• If there are many challenges and few supports, the text is probably best for storytelling or reading aloud.. • If there are more challenges than supports, the text is probably

The Recommendation Form (Appendix E) should be completed by the Principal of the applicant’s serving school and returned to the Education Bureau at the following address

Study the following statements. Put a “T” in the box if the statement is true and a “F” if the statement is false. Only alcohol is used to fill the bulb of a thermometer. An

• Teaching grammar through texts enables students to see how the choice of language items is?. affected by the context and how it shapes the tone, style and register of

By correcting for the speed of individual test takers, it is possible to reveal systematic differences between the items in a test, which were modeled by item discrimination and

For a polytomous item measuring the first-order latent trait, the item response function can be the generalized partial credit model (Muraki, 1992), the partial credit model