Skip to content

Commit

Permalink
Update API model
Browse files Browse the repository at this point in the history
  • Loading branch information
@aws-sdk-cpp-automation
aws-sdk-cpp-automation committed Jan 17, 2025
1 parent f03ab93 commit ba9f657
Show file tree
Hide file tree
Showing 5 changed files with 2,860 additions and 570 deletions.
2 changes: 1 addition & 1 deletion tools/code-generation/smithy/api-descriptions/bedrock-runtime.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4892,7 +4892,7 @@
"min": 1,
"max": 64
},
"smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
"smithy.api#pattern": "^[a-zA-Z0-9_-]+$"
}
},
"com.amazonaws.bedrockruntime#ToolResultBlock": {
Expand Down
10 changes: 5 additions & 5 deletions tools/code-generation/smithy/api-descriptions/detective.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@
"name": "detective"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.</p>\n <p>The Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.</p>\n <p>To add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.</p>\n <p>Detective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.</p>\n <p>The Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.</p>\n <p>Every behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.</p>\n <p>The administrator account for a behavior graph can use the Detective API to do\n the following:</p>\n <ul>\n <li>\n <p>Enable and disable Detective. Enabling Detective creates a new\n behavior graph.</p>\n </li>\n <li>\n <p>View the list of member accounts in a behavior graph.</p>\n </li>\n <li>\n <p>Add member accounts to a behavior graph.</p>\n </li>\n <li>\n <p>Remove member accounts from a behavior graph.</p>\n </li>\n <li>\n <p>Apply tags to a behavior graph.</p>\n </li>\n </ul>\n <p>The organization management account can use the Detective API to select the\n delegated administrator for Detective.</p>\n <p>The Detective administrator account for an organization can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>Perform all of the functions of an administrator account.</p>\n </li>\n <li>\n <p>Determine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.</p>\n </li>\n </ul>\n <p>An invited member account can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>View the list of behavior graphs that they are invited to.</p>\n </li>\n <li>\n <p>Accept an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Decline an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Remove their account from a behavior graph.</p>\n </li>\n </ul>\n <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>\n <note>\n <p>We replaced the term \"master account\" with the term \"administrator account\". An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.</p>\n </note>",
"smithy.api#documentation": "<p>Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.</p>\n <p>The Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.</p>\n <p>To add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.</p>\n <p>Detective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.</p>\n <p>The Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.</p>\n <p>Every behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.</p>\n <p>The administrator account for a behavior graph can use the Detective API to do\n the following:</p>\n <ul>\n <li>\n <p>Enable and disable Detective. Enabling Detective creates a new\n behavior graph.</p>\n </li>\n <li>\n <p>View the list of member accounts in a behavior graph.</p>\n </li>\n <li>\n <p>Add member accounts to a behavior graph.</p>\n </li>\n <li>\n <p>Remove member accounts from a behavior graph.</p>\n </li>\n <li>\n <p>Apply tags to a behavior graph.</p>\n </li>\n </ul>\n <p>The organization management account can use the Detective API to select the\n delegated administrator for Detective.</p>\n <p>The Detective administrator account for an organization can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>Perform all of the functions of an administrator account.</p>\n </li>\n <li>\n <p>Determine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.</p>\n </li>\n </ul>\n <p>An invited member account can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>View the list of behavior graphs that they are invited to.</p>\n </li>\n <li>\n <p>Accept an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Decline an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Remove their account from a behavior graph.</p>\n </li>\n </ul>\n <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>\n <note>\n <p>We replaced the term \"master account\" with the term \"administrator account\". An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.</p>\n </note>",
"smithy.api#title": "Amazon Detective",
"smithy.rules#endpointRuleSet": {
"version": "1.0",
Expand Down Expand Up @@ -2567,7 +2567,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Details about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html\">Detective investigations</a>.</p>"
"smithy.api#documentation": "<p>Details about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigation-about.html\">Detective investigations</a>.</p>"
}
},
"com.amazonaws.detective#IndicatorType": {
Expand Down Expand Up @@ -2953,7 +2953,7 @@
"IndicatorType": {
"target": "com.amazonaws.detective#IndicatorType",
"traits": {
"smithy.api#documentation": "<p>For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html\">Detective investigations</a>.</p>"
"smithy.api#documentation": "<p>For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigation-about.html\">Detective investigations</a>.</p>"
}
},
"NextToken": {
Expand Down Expand Up @@ -4472,7 +4472,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Starts a data source packages for the behavior graph.</p>",
"smithy.api#documentation": "<p>Starts a data source package for the Detective behavior graph.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph/datasources/update",
Expand All @@ -4493,7 +4493,7 @@
"DatasourcePackages": {
"target": "com.amazonaws.detective#DatasourcePackageList",
"traits": {
"smithy.api#documentation": "<p>The data source package start for the behavior graph.</p>",
"smithy.api#documentation": "<p>The data source package to start for the behavior graph.</p>",
"smithy.api#required": {}
}
}
Expand Down
Loading

0 comments on commit ba9f657

Please sign in to comment.